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

Add README files to CLI module packages

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
This commit is contained in:
Patrik Oldsberg
2026-03-15 15:03:35 +01:00
parent 7781ae5911
commit 4f2d7d555b
12 changed files with 208 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/cli-defaults/README.md
+26
View File
@@ -0,0 +1,26 @@
# @backstage/cli-defaults
The default set of CLI modules for the Backstage CLI. Installing this single package provides all standard CLI commands without needing to list each module individually.
## Included Modules
| Module | Description |
| :--------------------------------------------------------------------------- | :--------------------------------------- |
| [`@backstage/cli-module-auth`](../cli-module-auth) | Authentication commands |
| [`@backstage/cli-module-build`](../cli-module-build) | Build, start, and packaging commands |
| [`@backstage/cli-module-config`](../cli-module-config) | Configuration inspection commands |
| [`@backstage/cli-module-create-github-app`](../cli-module-create-github-app) | GitHub App creation |
| [`@backstage/cli-module-info`](../cli-module-info) | Environment and dependency info |
| [`@backstage/cli-module-lint`](../cli-module-lint) | Linting commands |
| [`@backstage/cli-module-maintenance`](../cli-module-maintenance) | Repository maintenance commands |
| [`@backstage/cli-module-migrate`](../cli-module-migrate) | Migration and version management |
| [`@backstage/cli-module-new`](../cli-module-new) | Scaffolding for new plugins and packages |
| [`@backstage/cli-module-test-jest`](../cli-module-test-jest) | Jest-based testing commands |
| [`@backstage/cli-module-translations`](../cli-module-translations) | Translation management commands |
For fine-grained control over which CLI commands are available, you can install individual modules instead.
## Documentation
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
- [Backstage Documentation](https://backstage.io/docs)
packages/cli-module-auth/README.md
+19
View File
@@ -0,0 +1,19 @@
# @backstage/cli-module-auth
CLI module that provides authentication commands for the Backstage CLI, enabling login, logout, and credential management for Backstage instances.
## Commands
| Command | Description |
| :----------------- | :------------------------------------------------------- |
| `auth login` | Log in the CLI to a Backstage instance |
| `auth logout` | Log out the CLI and clear stored credentials |
| `auth show` | Show details of an authenticated instance |
| `auth list` | List authenticated instances |
| `auth print-token` | Print an access token to stdout (auto-refresh if needed) |
| `auth select` | Select the default instance |
## Documentation
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
- [Backstage Documentation](https://backstage.io/docs)
packages/cli-module-build/README.md
+23
View File
@@ -0,0 +1,23 @@
# @backstage/cli-module-build
CLI module that provides build, start, and packaging commands for the Backstage CLI.
## Commands
| Command | Description |
| :----------------- | :------------------------------------------------------------------------ |
| `package build` | Build a package for production deployment or publishing |
| `package start` | Start a package for local development |
| `package clean` | Delete cache directories |
| `package prepack` | Prepares a package for packaging before publishing |
| `package postpack` | Restores the changes made by the prepack command |
| `repo build` | Build packages in the project, excluding bundled app and backend packages |
| `repo start` | Starts packages in the repo for local development |
| `repo clean` | Delete cache and output directories |
| `build-workspace` | Builds a temporary dist workspace from the provided packages |
## Documentation
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
- [Backstage Documentation](https://backstage.io/docs)
- [Build System](https://backstage.io/docs/tooling/cli/build-system)
packages/cli-module-config/README.md
+18
View File
@@ -0,0 +1,18 @@
# @backstage/cli-module-config
CLI module that provides configuration inspection commands for the Backstage CLI.
## Commands
| Command | Description |
| :-------------- | :------------------------------------------------------------- |
| `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` | Print the JSON schema for the given configuration |
## Documentation
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
- [Backstage Documentation](https://backstage.io/docs)
- [Static Configuration](https://backstage.io/docs/conf/)
packages/cli-module-create-github-app/README.md
+14
View File
@@ -0,0 +1,14 @@
# @backstage/cli-module-create-github-app
CLI module that provides the `create-github-app` command for the Backstage CLI, used to create a new GitHub App in your organization for use with Backstage.
## Commands
| Command | Description |
| :------------------ | :----------------------------------------- |
| `create-github-app` | Create new GitHub App in your organization |
## Documentation
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
- [Backstage Documentation](https://backstage.io/docs)
packages/cli-module-info/README.md
+14
View File
@@ -0,0 +1,14 @@
# @backstage/cli-module-info
CLI module that provides the `info` command for the Backstage CLI, displaying environment and dependency information useful for debugging and bug reports.
## Commands
| Command | Description |
| :------ | :-------------------------------------------------------- |
| `info` | Show helpful information for debugging and reporting bugs |
## Documentation
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
- [Backstage Documentation](https://backstage.io/docs)
packages/cli-module-lint/README.md
+15
View File
@@ -0,0 +1,15 @@
# @backstage/cli-module-lint
CLI module that provides linting commands for the Backstage CLI.
## Commands
| Command | Description |
| :------------- | :---------------- |
| `package lint` | Lint a package |
| `repo lint` | Lint a repository |
## Documentation
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
- [Backstage Documentation](https://backstage.io/docs)
packages/cli-module-maintenance/README.md
+15
View File
@@ -0,0 +1,15 @@
# @backstage/cli-module-maintenance
CLI module that provides repository maintenance commands for the Backstage CLI.
## Commands
| Command | Description |
| :----------------------- | :---------------------------------------- |
| `repo fix` | Automatically fix packages in the project |
| `repo list-deprecations` | List deprecations |
## Documentation
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
- [Backstage Documentation](https://backstage.io/docs)
packages/cli-module-migrate/README.md
+20
View File
@@ -0,0 +1,20 @@
# @backstage/cli-module-migrate
CLI module that provides migration and version management commands for the Backstage CLI.
## Commands
| Command | Description |
| :----------------------------- | :---------------------------------------------------------------- |
| `versions:bump` | Bump Backstage packages to the latest versions |
| `versions:migrate` | Migrate plugins moved to the @backstage-community namespace |
| `migrate package-roles` | Add package role field to packages that don't have it |
| `migrate package-scripts` | Set package scripts according to each package role |
| `migrate package-exports` | Synchronize package subpath export definitions |
| `migrate package-lint-configs` | Migrates all packages to use @backstage/cli/config/eslint-factory |
| `migrate react-router-deps` | Migrates the react-router dependencies to be peer dependencies |
## Documentation
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
- [Backstage Documentation](https://backstage.io/docs)
packages/cli-module-new/README.md
+14
View File
@@ -0,0 +1,14 @@
# @backstage/cli-module-new
CLI module that provides the `new` command for the Backstage CLI, offering an interactive guide to scaffold new plugins, packages, and modules in your Backstage app.
## Commands
| Command | Description |
| :------ | :-------------------------------------------------------------- |
| `new` | Open up an interactive guide to creating new things in your app |
## Documentation
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
- [Backstage Documentation](https://backstage.io/docs)
packages/cli-module-test-jest/README.md
+15
View File
@@ -0,0 +1,15 @@
# @backstage/cli-module-test-jest
CLI module that provides Jest-based testing commands for the Backstage CLI.
## Commands
| Command | Description |
| :------------- | :---------------------------------------------------------------- |
| `package test` | Run tests, forwarding arguments to Jest, defaulting to watch mode |
| `repo test` | Run tests, forwarding arguments to Jest, defaulting to watch mode |
## Documentation
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
- [Backstage Documentation](https://backstage.io/docs)
packages/cli-module-translations/README.md
+15
View File
@@ -0,0 +1,15 @@
# @backstage/cli-module-translations
CLI module that provides translation management commands for the Backstage CLI.
## Commands
| Command | Description |
| :-------------------- | :------------------------------------------------------------------------------------ |
| `translations export` | Export translation messages from an app and all of its frontend plugins to JSON files |
| `translations import` | Generate translation resource wiring from translated JSON files |
## Documentation
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
- [Backstage Documentation](https://backstage.io/docs)