Skip to main content
Version: Next

Search Module

The search module (@backstage/cli-module-search) provides intent-based commands for searching across Backstage content, such as docs search "my service".

Prerequisites​

Before using search commands you must authenticate with a Backstage instance using auth login and register the search plugin source using actions sources add search.

All commands support --output json for machine-readable output and --instance <name> to target a specific authenticated instance.

Search across all content types (catalog entities, TechDocs, templates).

Usage: backstage-cli search <term> [options]

Options:
  --types <list>          Comma-separated types
  --filter <key=value>    Query filter (repeatable)
  --page-limit <number>   Results per page (default: 10)
  --page-cursor <cursor>  Pagination cursor
  --output <format>       Output format: human (default), json
  --instance <name>       Instance name

Wraps search:query. Repeat --filter to add filters.

Examples​

yarn backstage-cli search "deployment guide"
yarn backstage-cli search "auth" --types techdocs,software-catalog
yarn backstage-cli search "service" --filter kind=Component --filter lifecycle=production

Search TechDocs content specifically.

Usage: backstage-cli docs search <term> [options]

Options:
  --page-limit <number>   Results per page (default: 10)
  --page-cursor <cursor>  Pagination cursor
  --output <format>       Output format: human (default), json
  --instance <name>       Instance name

Wraps search:query with types=["techdocs"] automatically applied.

Examples​

yarn backstage-cli docs search "getting started"