@backstage/cli

CLI for developing Backstage plugins and apps

  • Types
  • ESM
  • CJS
License
Apache-2.0
Install Size
685.9 kB(313.1 MB)
Vulns
0
Published

Get started

$npm install @backstage/cli
$pnpm add @backstage/cli
$yarn add @backstage/cli
$bun add @backstage/cli
$deno add npm:@backstage/cli
$vlt install @backstage/cli
$vp add @backstage/cli
# Run locally
$npx backstage-cli
$pnpm exec backstage-cli
$npx backstage-cli
$bunx backstage-cli
$deno run npm:@backstage/cli
$vlx backstage-cli
$vp exec backstage-cli

Readme

@backstage/cli

This package provides a CLI for developing Backstage plugins and apps.

Installation

Install the package via Yarn:

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 run the cli in watch mode, use yarn start <args>. For example yarn start lint --help.

To try out the command locally, you can execute the following from the parent directory of this repo:

./backstage/packages/cli/bin/backstage-cli --help

Documentation