From 84340367c497343ffd774a8ecefdb4ae474e4428 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 8 Apr 2020 22:28:02 +0200 Subject: [PATCH] packages/cli: added some development docs to the readme (#521) --- packages/cli/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/packages/cli/README.md b/packages/cli/README.md index 99afb635ceba3..eb208d10e5b48 100644 --- 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)