Command cheat sheet - AppSignal Documentation

This page lists every AppSignal CLI command in one place, so you can scan for the one you need instead of stepping through a guided walkthrough. For a fuller explanation of any area, follow the link at the top of each section.

Setup and account

Get the CLI connected to your AppSignal account. See Authentication and Project configuration for details.

Command	What it does
`appsignal-cli about`	Show an overview of your setup: version, endpoint, default organization, and authentication status
`appsignal-cli --version`	Print the installed CLI version
`appsignal-cli auth login`	Authenticate with AppSignal via OAuth
`appsignal-cli auth logout`	Remove stored credentials
`appsignal-cli auth status`	Show the current authentication status
`appsignal-cli project init`	Create or update the project-local `.appsignal.toml` config

Applications

List and inspect the apps in your organization. See Apps.

Command	What it does
`appsignal-cli apps list`	List all applications for the current organization
`appsignal-cli apps info --app-id <APP_ID>`	Show details for one application by ID
`appsignal-cli apps find --name <NAME>`	Find an application by name and optional environment
`appsignal-cli apps set-org --org <ORG>`	Set the default organization slug
`appsignal-cli apps show-org`	Show the current default organization
`appsignal-cli apps resources <RESOURCE> --app <APP>`	Show app resources: `all`, `users`, `notifiers`, `namespaces`, `dashboards`, or `deploy-markers`

Incidents

List incidents, open their details, and update them. See Incidents.

Command	What it does
`appsignal-cli incidents list --app <APP>`	List incidents of all types for an app
`appsignal-cli incidents list-exceptions --app <APP>`	List exception incidents, with text search support
`appsignal-cli incidents list-performance --app <APP>`	List performance incidents, with text search support
`appsignal-cli incidents list-anomalies --app <APP>`	List anomaly detection incidents
`appsignal-cli incidents show --number <NUMBER> --app <APP>`	Show details for one incident by number
`appsignal-cli incidents update --number <NUMBER> --app <APP>`	Update an incident’s state, severity, or assignees
`appsignal-cli incidents add-note --number <NUMBER> --content <CONTENT> --app <APP>`	Add a note to an incident

Logs

Stream, search, and inspect log data. See Logs and the query syntax reference.

Command	What it does
`appsignal-cli logs tail --app <APP>`	Tail (stream) log lines in real time, with optional filters
`appsignal-cli logs search --app <APP>`	Search log lines with a one-shot query
`appsignal-cli logs views --app <APP>`	List saved log views (filter presets) for an app
`appsignal-cli logs sources --app <APP>`	List log sources for an app

Log-derived metrics

Command	What it does
`appsignal-cli logs metrics list --app <APP>`	List log-derived metrics for an app
`appsignal-cli logs metrics create --name <NAME> --query <QUERY> --app <APP>`	Create a new log-derived metric
`appsignal-cli logs metrics update --id <ID> --app <APP>`	Update a log-derived metric
`appsignal-cli logs metrics delete --id <ID> --app <APP>`	Delete a log-derived metric

Log-based triggers

Command	What it does
`appsignal-cli logs triggers list --app <APP>`	List log-based triggers for an app
`appsignal-cli logs triggers create --name <NAME> --query <QUERY> --app <APP>`	Create a new log-based trigger
`appsignal-cli logs triggers update --id <ID> --app <APP>`	Update an existing log-based trigger
`appsignal-cli logs triggers delete --id <ID> --app <APP>`	Delete a log-based trigger

Traces

Fetch and inspect performance samples and error traces. See Traces. samples and sample are aliases for traces.

Command	What it does
`appsignal-cli traces list --namespace <NAMESPACE> --action <ACTION_NAME> --app <APP>`	List performance samples for an action
`appsignal-cli traces incident --number <NUMBER> --app <APP>`	List performance samples for an incident
`appsignal-cli traces errors --digest <DIGEST> --app <APP>`	List error traces for an exception digest
`appsignal-cli traces show --namespace <NAMESPACE> --action <ACTION_NAME> --trace-id <TRACE_ID> --app <APP>`	Show a performance sample’s span tree
`appsignal-cli traces show-error --digest <DIGEST> --trace-id <TRACE_ID> --app <APP>`	Show an error trace’s span tree
`appsignal-cli traces show-incident --number <NUMBER> --trace-id <TRACE_ID> --app <APP>`	Show a trace from an incident without passing namespace, action, or digest

Dashboards

List, create, and update dashboards. See Dashboards.

Command	What it does
`appsignal-cli dashboards list --app <APP>`	List dashboards for an app
`appsignal-cli dashboards create --title <TITLE> --app <APP>`	Create a new dashboard
`appsignal-cli dashboards update --id <ID> --title <TITLE> --app <APP>`	Update an existing dashboard

Anomaly detection triggers

Manage anomaly detection triggers. See Triggers.

Command	What it does
`appsignal-cli triggers list --app <APP>`	List triggers for an app
`appsignal-cli triggers create --app <APP>`	Create a new trigger. Requires `--metric-name`, `--kind`, `--field`, `--comparison-operator`, `--condition-value`, `--warmup-duration`, and `--cooldown-duration`
`appsignal-cli triggers update --id <ID> --app <APP>`	Update a trigger by creating a new version linked to the existing one
`appsignal-cli triggers archive --id <ID> --app <APP>`	Archive a trigger and close its alerts and incidents

Agent skill

Install and manage the bundled AppSignal skill for AI agents. See Agent skill.

Command	What it does
`appsignal-cli skill install`	Install the bundled AppSignal skill into an agent’s skills directory
`appsignal-cli skill update`	Update an installed AppSignal skill to the bundled version
`appsignal-cli skill status`	Show whether installed AppSignal skills are current

Feedback

Command	What it does
`appsignal-cli feedback "<MESSAGE>"`	Send feedback about the CLI to AppSignal. Add `--email <EMAIL>` to include a contact address

General Conventions

A few things apply to every command:

Get help for any command by adding --help (-h), for example appsignal-cli logs tail --help. It lists the subcommands, arguments, and options.
Choose the output format with --output json (-o json) for machine-readable JSON, or leave it off for human-readable output. --format is a synonym.
Target an app for commands that read or change app data by passing either --app <APP> (optionally with --environment <ENVIRONMENT>) or --app-id <APP_ID>. Set a default organization once with appsignal-cli apps set-org --org <ORG> so you can omit --org.

In the tables above, only the required arguments are shown. Run a command with --help to see its full set of options.

​Setup and account

​Applications

​Incidents

​Logs

​Log-derived metrics

​Log-based triggers

​Traces

​Dashboards

​Anomaly detection triggers

​Agent skill

​Feedback

​General Conventions