From 07161730ccee8eeccf81b2e72285602d81fd5850 Mon Sep 17 00:00:00 2001 From: Yuvaraja Balamurugan Date: Tue, 31 Aug 2021 10:49:21 +0530 Subject: [PATCH] Add documentation for info command :book: Signed-off-by: Yuvaraja Balamurugan --- docs/cli/commands.md | 13 +++++++++++++ packages/cli/src/commands/index.ts | 2 +- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/cli/commands.md b/docs/cli/commands.md index ff61e51c75..b5bb73949e 100644 --- a/docs/cli/commands.md +++ b/docs/cli/commands.md @@ -57,6 +57,7 @@ postpack Restores the changes made by the prepack command create-github-app Create new GitHub App in your organization (experimental) +info Outputs versions of all dependencies for debugging purposes help [command] display help for command ``` @@ -647,3 +648,15 @@ YAML file that can be referenced in the GitHub integration configuration. ```text Usage: backstage-cli create-github-app <github-org> ``` + +## info + +Scope: `root` + +Outputs debug information which is useful when opening an issue. Outputs system +information, node.js and npm versions, CLI version and type (inside backstage +repo or a created app), all `@backstage/*` package dependency versions. + +```text +Usage: backstage-cli info +``` diff --git a/packages/cli/src/commands/index.ts b/packages/cli/src/commands/index.ts index 0feff5ad9e..efade740a3 100644 --- a/packages/cli/src/commands/index.ts +++ b/packages/cli/src/commands/index.ts @@ -227,7 +227,7 @@ export function registerCommands(program: CommanderStatic) { program .command('info') - .description('Debug info of dependencies.') + .description('Debug info of all dependencies.') .action(lazy(() => import('./info').then(m => m.default))); }