backstage-api-cli v1.1.1

Backstage API CLI

Welcome to the Backstage API CLI project!

Introduction

The Backstage CLI is a command-line tool designed to help developers manage and interact with Backstage data.

Installation

To install the Backstage API CLI, use the following command:

npm install -g backstage-api-cli

Usage

Before using the CLI, you need to set two environment variables:

export BACKSTAGE_API_URL="https://your-backstage-api-url.com/api"
export BACKSTAGE_API_KEY="your-backstage-api-key"

Here are some examples of how to use the Backstage CLI:

Get Information About an Entity

Get information about a specific entity by name

backstage-api-cli info <entity>

List Orphan Entities

List all orphan entities in the Backstage catalog

backstage-api-cli list-orphans

Options:
  -l, --limit <number>  Limit the number of entities displayed (default: 10)

List Entity Lifecycle

List all Backstage lifecycle

backstage-api-cli spec-lifecycle

Options:
  -l, --limit <number>  Limit the number of entities displayed (default: 10)

List Metadata Tags

List all Backstage metadata tags

backstage-api-cli metadata-tags

Options:
  -l, --limit <number>  Limit the number of entities displayed (default: 10)

List All Metadata Namespaces

List all Backstage metadata namespaces

backstage-api-cli metadata-namespace

Options:
  -l, --limit <number>  Limit the number of entities displayed (default: 10)

List all Entity Kinds

List all Backstage entity kinds

backstage-api-cli metadata-kind

Options:
  -l, --limit <number>  Limit the number of entities displayed (default: 10)

List all TechDocs Enabled Entities

List all entities with TechDocs enabled

backstage-api-cli list-techdocs

Options:
  -l, --limit <number>  Limit the number of entities displayed (default: 10)
  -a, --all             Show all entities
  -o, --output <file.csv>   Save output to a CSV file
  -h, --help            display help for command

For a full list of available commands, run:

backstage-api-cli --help

License

This project is licensed under the MIT License.