From ff42512d3a31f2a51814bcf35a2ca7ef53b36590 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 14 Apr 2021 17:47:27 +0200 Subject: [PATCH] docs/cli: add config:docs command Signed-off-by: Patrik Oldsberg --- docs/cli/commands.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/cli/commands.md b/docs/cli/commands.md index 33693b010f..324d17463c 100644 --- a/docs/cli/commands.md +++ b/docs/cli/commands.md @@ -44,6 +44,7 @@ clean Delete cache directories create-plugin Creates a new plugin in the current repository remove-plugin Removes plugin in the current repository +config:docs Browse the configuration reference documentation config:print Print the app configuration for the current package config:check Validate that the given configuration loads and matches schema config:schema Dump the app configuration schema @@ -447,6 +448,25 @@ Options: --backstage-cli-help display help for command ``` +## config:docs + +Scope: `root` + +This commands opens up the reference documentation of your apps local +configuration schema in the browser. This is useful to get an overview of what +configuration values are available to use, a description of what they do and +their format, and where they get sent. + +```text +Usage: backstage-cli config:docs [options] + +Browse the configuration reference documentation + +Options: + --package Only include the schema that applies to the given package + -h, --help display help for command +``` + ## config:print Scope: `root`