Skip to content

Context CLI

CLI for logging in and fetching Graphsignal signal summary and signal context.

Install as an isolated CLI tool with uv:

Terminal window
uv tool install graphsignal-context

Store your Graphsignal API key in ~/.graphsignal/config.yml.

Terminal window
graphsignal-context login

You will be prompted for your API key.

Login is not required if the GRAPHSIGNAL_API_KEY environment variable is set.

Fetch information about signals.

Terminal window
graphsignal-context guide

Behavior:

  • Requires a saved API key (graphsignal-context login).
  • Calls GET /api/v1/context/guide/ on https://api.graphsignal.com.
  • Prints the returned text content to stdout.

Fetch full signal context (profiles, errors, traces, metrics) for a time range and print it as JSON. Same options as summary. Calls GET /api/v1/context/signals/.

Terminal window
graphsignal-context signals \
--start 2026-03-10T00:00:00Z \
--end 2026-03-12T00:00:00Z \
--tags "env:prod;service:inference"

Fetch a pre-computed, scalar-only signal summary (performance analysis) for a time range and print it as JSON. Start here for a lightweight overview, then use graphsignal-context signals to drill down. Calls GET /api/v1/context/summary/.

The summary describes a single engine run: --tags must include the run.uid tag, otherwise the API returns an error. run.uid is set automatically by the profiler per engine process launch; find values in available_tags of a graphsignal-context signals response.

Terminal window
graphsignal-context summary \
--start 2026-03-10T00:00:00Z \
--end 2026-03-12T00:00:00Z \
--tags "run.uid:1a2b3c4d5e6f"

Options:

  • --start (required): Start of time range in ISO 8601 format (for example, 2026-03-10T00:00:00Z).
  • --end (required): End of time range in ISO 8601 format. Must be after --start.
  • --tags (required for summary): Semicolon-separated key:value pairs for exact tag filtering. Must include the run.uid tag.