Docs
Generate CLI documentation
beam docs [options]
About
Generate CLI documentation
Options
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 |
--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 |
--version | Boolean | Show version information |
--help | Boolean | Show help and usage information |
Updated about 17 hours ago