1 | # @backstage/cli
|
2 |
|
3 | This package provides a CLI for developing Backstage plugins and apps.
|
4 |
|
5 | ## Installation
|
6 |
|
7 | Install the package via Yarn:
|
8 |
|
9 | ```sh
|
10 | yarn add @backstage/cli
|
11 | ```
|
12 |
|
13 | ## Development
|
14 |
|
15 | For local development the cli can be used directly, even from other packages in this repo. The `bin/backstage-cli` entrypoint contains a switch that will load the implementation from the `src` directory when executed inside this repo.
|
16 |
|
17 | To run the cli in watch mode, use `yarn start <args>`. For example `yarn start lint --help`.
|
18 |
|
19 | To try out the command locally, you can execute the following from the parent directory of this repo:
|
20 |
|
21 | ```bash
|
22 | ./backstage/packages/cli/bin/backstage-cli --help
|
23 | ```
|
24 |
|
25 | ## Documentation
|
26 |
|
27 | - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
28 | - [Backstage Documentation](https://backstage.io/docs)
|