Skip to content

Commit

Permalink
docs: add a note on src/index.ts
Browse files Browse the repository at this point in the history
  • Loading branch information
kanadgupta committed Dec 4, 2024
1 parent a394c03 commit 5ecfca9
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@ import WhoAmICommand from './commands/whoami.js';
export { default as createGHA } from './lib/hooks/createGHA.js';
export { default as prerun } from './lib/hooks/prerun.js';

/**
* All the commands available in the CLI. We use the `explicit` command discovery strategy
* so we can properly bundle the CLI for usage in GitHub Actions.
*
* Also, we use colon separators for subcommands below. This ensures that users can use both colons
* and spaces when running subcommands. The documentation will always show spaces, but colons are
* also supported.
*
* @see {@link https://oclif.io/docs/command_discovery_strategies/#explicit-strategy}
*/
export const COMMANDS = {
categories: CategoriesCommand,
'categories:create': CategoriesCreateCommand,
Expand Down

0 comments on commit 5ecfca9

Please sign in to comment.