Docs

Generate CLI documentation

beam docs [options]

About

Generate CLI documentation

Options

NameTypeDescription
--categoryStringThe category slug to use
--command-slugStringThe parent slug for all command docs
--guide-slugStringThe parent slug for all guide docs
--readme-keyStringThe api key to use to push to Readme
--dryrunBooleanShould any networking happen?
--cidStringCid to use; will default to whatever is in the file system
--pidStringPid to use; will default to whatever is in the file system
--hostStringThe host endpoint for beamable
--refresh-tokenStringRefresh token to use for the requests
--logStringExtra logs gets printed out
--dirStringDirectory to use for configuration
--versionBooleanShow version information
--helpBooleanShow help and usage information