From 051995aba59994122e32f3c64bc523d81cc0c469 Mon Sep 17 00:00:00 2001 From: Min Kim Date: Sat, 21 Dec 2024 17:05:41 -0500 Subject: [PATCH] Update new command documentation Signed-off-by: Min Kim --- docs/tooling/cli/03-commands.md | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/docs/tooling/cli/03-commands.md b/docs/tooling/cli/03-commands.md index 2da7e11ef4..23b7f2ddec 100644 --- a/docs/tooling/cli/03-commands.md +++ b/docs/tooling/cli/03-commands.md @@ -253,35 +253,27 @@ Restores the changes made by the prepack command ## new The `new` command opens up an interactive guide for you to create new things -in your app. If you do not pass in any options it is completely interactive, but -it is possible to pre-select what you want to create using the `--select` flag, -and provide options using `--option`, for example: +in your app. ```bash -backstage-cli new --select plugin --option id=foo +backstage-cli new ``` This command is typically added as script in the root `package.json` to be -executed with `yarn new`, using options that are appropriate for the organization -that owns the app repo. For example you may have it set up like this: +executed with `yarn new`. For example you may have it set up like this: ```json { "scripts": { - "new": "backstage-cli new --scope internal --no-private --npm-registry https://acme.org/npm" + "new": "backstage-cli new" } } ``` ```text -Usage: backstage-cli create [options] +Usage: backstage-cli new Options: - --select Select the thing you want to be creating upfront - --option = Pre-fill options for the creation process (default: []) - --scope The scope to use for new packages - --npm-registry The package registry to use for new packages - --no-private Do not mark new packages as private -h, --help display help for command ```