packages/cli: added some development docs to the readme (backstage#521)

carlsim0n · Apr 8, 2020 · 8434036 · 8434036
1 parent 27d9524
commit 8434036
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -16,6 +16,16 @@ or
 $ yarn add @backstage/cli
 ```
 
+## Development
+
+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.
+
+To try out the `create-app` command locally, you can execute the following from the parent directory of this repo:
+
+```bash
+./backstage/packages/cli/bin/backstage-cli create-app
+```
+
 ## Documentation
 
 - [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)