From 2f851a3945de3e5bb80ffe15e7ecd939d72d67e3 Mon Sep 17 00:00:00 2001 From: Marcus Eide Date: Thu, 16 Feb 2023 14:05:16 +0100 Subject: [PATCH] cli: Add minimal instructions for how to try locally Signed-off-by: Marcus Eide --- packages/cli/src/commands/admin/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 packages/cli/src/commands/admin/README.md diff --git a/packages/cli/src/commands/admin/README.md b/packages/cli/src/commands/admin/README.md new file mode 100644 index 0000000000..d2a6e10256 --- /dev/null +++ b/packages/cli/src/commands/admin/README.md @@ -0,0 +1,23 @@ +# admin tool + +## Local dev + +```bash +# Checkout the branch +cd backstage +git fetch +git checkout goa/cli-admin-command + +# Create a new app +cd .. +npx @backstage/create-app +cd new-backstage-app + +# Run the modded cli in the new app +../github/backstage/packages/cli/bin/backstage-cli admin +? Do you want to set up Authentication for this project? (Y/n) +... + +# Try the app with the new changes +yarn dev +```