diff --git a/docs/local-dev/cli-commands.md b/docs/local-dev/cli-commands.md index 66a1855fca..29cc8635aa 100644 --- a/docs/local-dev/cli-commands.md +++ b/docs/local-dev/cli-commands.md @@ -10,55 +10,64 @@ and where to use them. ## help This command displays a help summary or detailed help screens for each command. -Below is a cleaned up output of `yarn backstage-cli --help` +Below is a cleaned up output of `yarn backstage-cli --help`: ```text -repo [command] Command that run across an entire Backstage project -package [command] Lifecycle scripts for individual packages -migrate [command] Migration utilities - -create Open up an interactive guide to creating new things in your app - -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 - -versions:bump Bump Backstage packages to the latest versions -versions:check Check Backstage package versioning - -build-workspace Builds a temporary dist workspace from the provided packages -create-github-app Create new GitHub App in your organization (experimental) - -info Show helpful information for debugging and reporting bugs -help [command] display help for command +new [options] Open up an interactive guide to creating new things in + your app +test Run tests, forwarding args to Jest, defaulting to watch + mode [DEPRECATED] +config:docs [options] Browse the configuration reference documentation +config:print [options] Print the app configuration for the current package +config:check [options] Validate that the given configuration loads and matches + schema +config:schema [options] Print configuration schema +repo [command] Command that run across an entire Backstage project +package [command] Lifecycle scripts for individual packages +migrate [command] Migration utilities +versions:bump [options] Bump Backstage packages to the latest versions +versions:check [options] Check Backstage package versioning +clean Delete cache directories [DEPRECATED] +build-workspace [packages...] Builds a temporary dist workspace from the provided + packages +create-github-app Create new GitHub App in your organization. +info Show helpful information for debugging and reporting bugs +help [command] display help for command ``` -The `package` command category, `yarn backstage-cli package --help` +The `package` command category, `yarn backstage-cli package --help`: ```text -start [options] Start a package for local development -build [options] Build a package for production deployment or publishing -lint [options] Lint a package -test Run tests, forwarding args to Jest, defaulting to watch mode -clean Delete cache directories -prepack Prepares a package for packaging before publishing -postpack Restores the changes made by the prepack command +start [options] Start a package for local development +build [options] Build a package for production deployment or publishing +lint [options] [directories...] Lint a package +test Run tests, forwarding args to Jest, defaulting to watch mode +clean Delete cache directories +prepack Prepares a package for packaging before publishing +postpack Restores the changes made by the prepack command +help [command] display help for command ``` -The `repo` command category, `yarn backstage-cli repo --help` +The `repo` command category, `yarn backstage-cli repo --help`: ```text -build [options] Build packages in the project, excluding bundled app and backend packages. -lint [options] Lint all packages in the project +build [options] Build packages in the project, excluding bundled app and backend packages. +lint [options] Lint all packages in the project +clean Delete cache and output directories +list-deprecations [options] List deprecations +test [options] Run tests, forwarding args to Jest, defaulting to watch mode +help [command] display help for command ``` -The `migrate` command category, `yarn backstage-cli migrate --help` +The `migrate` command category, `yarn backstage-cli migrate --help`: ```text package-roles Add package role field to packages that don't have it package-scripts Set package scripts according to each package role +package-exports Synchronize package subpath export definitions package-lint-configs Migrates all packages to use @backstage/cli/config/eslint-factory +react-router-deps Migrates the react-router dependencies for all packages to be peer dependencies +help [command] display help for command ``` ## repo build @@ -235,7 +244,7 @@ Options: -h, --help display help for command ``` -## config:docs +## config\:docs 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 @@ -252,7 +261,7 @@ Options: -h, --help display help for command ``` -## config:print +## config\:print Print the static configuration, defaulting to reading `app-config.yaml` in the repo root, using schema collected from all local packages in the repo. @@ -277,7 +286,7 @@ Options: -h, --help display help for command ``` -## config:check +## config\:check Validate that static configuration loads and matches schema, defaulting to reading `app-config.yaml` in the repo root and using schema collected from all @@ -296,7 +305,7 @@ Options: -h, --help display help for command ``` -## config:schema +## config\:schema Dump the configuration schema that was collected from all local packages in the repo. @@ -315,7 +324,7 @@ Options: -h, --help display help for command ``` -## versions:bump +## versions\:bump Bump all `@backstage` packages to the latest versions. This checks for updates in the package registry, and will update entries both in `yarn.lock` and @@ -330,7 +339,7 @@ Options: --release Bump to a specific Backstage release line or version (default: "main") ``` -## versions:check +## versions\:check Validate `@backstage` dependencies within the repo, making sure that there are no duplicates of packages that might lead to breakages.