Scout CLI

Scout CLI brings observability workflows to your terminal. Authenticate with the Scout platform to query logs, metrics, traces, alerts, and service topology — or use the open-source config commands to validate, generate, and test OpenTelemetry Collector configurations without a backend.

Platform Commands

These commands require authentication with a Scout backend.

Command	Description
login	Authenticate with the Scout platform
logout	Remove stored credentials
status	Check authentication status
context	Manage multiple account contexts
alerts	Query alert history
logs	Query service logs
metrics	Query service metrics
traces	Query distributed traces
service-map	Visualize service topology

Open Source Commands

These commands work entirely offline with no Scout account required.

Command	Description
config validate	Validate an OTel Collector YAML config
config init	Generate a production-ready OTel Collector config
config test	Live-test an OTel Collector config

No account needed

The scout config commands are fully open source. You can validate, generate, and test OpenTelemetry Collector configurations without signing up for Scout.

Quick Start

Platform users — authenticate and start querying:

scout login --account my-org
scout logs payment-service --since 10m
scout traces payment-service --status Error

Open-source users — generate and validate a collector config:

scout config init
scout config validate --file otel-collector-config.yaml
scout config test --file otel-collector-config.yaml

Global Flags

Every command accepts these flags:

Flag	Description
-v, --verbose	Enable verbose debug logging to stderr
-a, --account <NAME>	Override the active account context

See Global Flags for details.

See Also

• Installation — install Scout CLI
• Global Flags — flags available on every command
• Environment Variables — configure Scout via env vars