Docs

[INTERNAL] Generate CLI documentation

beam docs [options]

About

[INTERNAL] Generate CLI documentation

Name	Type	Description
--category	String	The category slug to use
--command-slug	String	The parent slug for all command docs
--guide-slug	String	The parent slug for all guide docs
--readme-key	String	The api key to use to push to Readme
--dryrun	Boolean	Should any networking happen?
--cid	String	Cid to use; will default to whatever is in the file system
--pid	String	Pid to use; will default to whatever is in the file system
--quiet	Boolean	When true, skip input waiting and use defaults
--host	String	The host endpoint for beamable
--refresh-token	String	Refresh token to use for the requests
--log	String	Extra logs gets printed out
--dir	String	Directory to use for configuration
--raw	Boolean	Output raw JSON to standard out. This happens by default when the command is being piped
--pretty	Boolean	Output syntax highlighted box text. This happens by default when the command is not piped
--dotnet-path	String	a custom location for dotnet
--version	Boolean	Show version information
--help	Boolean	Show help and usage information

Updated about 2 months ago