From 5ecfca96faab8b9f57909f0627eba3f3ef2b4db8 Mon Sep 17 00:00:00 2001 From: Kanad Gupta Date: Wed, 4 Dec 2024 15:19:05 -0600 Subject: [PATCH] docs: add a note on src/index.ts --- src/index.ts | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/index.ts b/src/index.ts index ab4bdda9a..6039677ad 100644 --- a/src/index.ts +++ b/src/index.ts @@ -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,