Scout APM CLI

A command-line interface for Scout Monitoring. Explore metrics, endpoints, traces, errors, and insights from the terminal.

Built in Go with Cobra, Lipgloss, BubbleTea, and asciigraph.

Install

Homebrew

brew install scoutapp/tap/scout-cli

Download binary

Pre-built binaries for macOS, Linux, and Windows are available on the GitHub Releases page.

Build from source

git clone https://github.com/scoutapp/scout-cli.git
cd scout-cli
go build -o scout .

Authentication

# Login
scout auth login --key YOUR_API_KEY

# Check auth status
scout auth status

# Clear credentials
scout auth logout

Credentials are stored in ~/.config/scout-apm/config.json. You can also set the SCOUT_API_KEY environment variable.

Usage

Apps

scout apps list
scout apps show 6

Metrics

scout metrics get --type response_time --app 6
scout metrics get --type throughput --app 6 --from 7d

Valid metric types: apdex, response_time, response_time_95th, errors, throughput, queue_time

Endpoints

scout endpoints list --app 6
scout endpoints metrics --endpoint YXBpL21ldHJpY3Mvc2hvdw== --type response_time --app 6

Traces

scout traces list --endpoint YXBpL21ldHJpY3Mvc2hvdw== --app 6
scout traces show 12345 --app 6

Errors

scout errors list --app 6
scout errors show 50560 --app 6
scout errors occurrences 50560 --app 6

Insights

scout insights list --app 6
scout insights show --type slow_query --app 6

Valid insight types: n_plus_one, memory_bloat, slow_query

Setup

scout setup           # List supported frameworks
scout setup rails     # Show setup docs for a framework

Global Flags

Flag	Description
--json	Output raw JSON (auto-enabled when piped)
--app <id>	Application ID (or set default_app_id in config)
--from <time>	Start time — relative (1h, 7d, 30m, 2w) or ISO 8601
--to <time>	End time (default: now)
--no-color	Disable colors (also respects NO_COLOR env)

Configuration

Config file: ~/.config/scout-apm/config.json

{
  "api_key": "your-api-key",
  "api_url": "https://scoutapm.com",
  "default_app_id": 6
}

Environment variable overrides: SCOUT_API_KEY, SCOUT_API_URL.

Testing

go test ./...

Shell Completion

scout completion bash   # Bash
scout completion zsh    # Zsh
scout completion fish   # Fish

Links

• Scout Monitoring — Application performance monitoring
• Documentation
• GitHub Releases