paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 42 Packages Projects Releases Wiki Activity

docs/tooling: add docs for new repo start command

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2025-04-06 11:59:44 +02:00
parent 1b27c4d434
commit b8a675df4b
1 changed files with 30 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/tooling/cli/03-commands.md
+30 -6
View File
@@ -48,12 +48,14 @@ help [command] display help for command
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
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
start [options] [packageName...] Starts packages in the repo for local development
build [options] Build packages in the project, excluding bundled app and backend packages.
test [options] Run tests, forwarding args to Jest, defaulting to watch mode
lint [options] Lint all packages in the project
fix [options] Automatically fix packages in the project
clean Delete cache and output directories
list-deprecations [options] List deprecations
help [command] display help for command
```
The `migrate` command category, `yarn backstage-cli migrate --help`:
@@ -67,6 +69,28 @@ react-router-deps Migrates the react-router dependencies for all packages to
help [command] display help for command
```
## repo start
Start a set of packages in the project for local development. If no explicit packages are listed via arguments or options, packages will instead be selected based on their [package role](./02-build-system.md#package-roles). If a single set of frontend and/or backend packages are found, they will be started. If there are multiple matches the directories 'packages/app' and 'packages/backend' will be preferred. If no matches are found the command will fall back to expecting a single plugin frontend and/or backend package to start instead.
Any `--config` options in the `start` script in `package.json` of the selected packages will be picked up and used, unless a `--config` option is provided to this command, in which case it will be used instead.
Any `--require` option in the `start` script in `package.json` of the selected backend package will be picked up and used.
```text
Usage: backstage-cli repo start [options] [packageName...]
Starts packages in the repo for local development
Arguments:
packageName Run the specified package instead of the defaults.
Options:
--config <path> Config files to load instead of app-config.yaml (default: [])
--plugin <pluginId> Start the dev entry-point for any matching plugin package in the repo (default: [])
--link <path> Link an external workspace for module resolution
```
## repo build
Builds all packages in the project, excluding bundled packages by default, i.e. ones