> ## Documentation Index
> Fetch the complete documentation index at: https://docs.appsignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AppSignal CLI

> Query your AppSignal data from the terminal: tail logs, inspect incidents, and manage triggers without leaving your shell.

The AppSignal CLI brings your monitoring data into the terminal, so you can work from the same shell where you run your tests and deploys. Tail logs as they arrive, search incidents and close them out, and manage anomaly detection triggers, all without opening the web UI. It's a single binary built in Rust, so there's nothing else to install.

The CLI is built for two kinds of users: people and AI agents. By default every command prints human-readable output; pass `--output json` and it returns machine-readable JSON instead. In other words, the same tool you reach for during an incident can also feed structured data to a coding agent. It even bundles an [AppSignal agent skill](/cli/skill): a set of instructions that teaches an agent like Claude or Codex how to use the CLI. Install it with `appsignal-cli skill install`.

<Note>
  The CLI talks to the same AppSignal data as the app UI and [AppSignal MCP](/mcp-server). It's a gateway to data AppSignal already has. If your app isn't sending logs, `logs tail` won't show any.
</Note>

## What you can do

* **Logs:** tail log lines as they arrive, or search across a time range with AppSignal's [query syntax](/logging/query-syntax). Filter by severity or source, apply saved log views, and list an app's views and sources. Create and manage log-derived metrics and log-based triggers from your log data.
* **Incidents:** list exception, performance, and anomaly incidents, and search the exception and performance ones by name or message; open an incident's details; update its state, severity, or assignees; and add notes.
* **Triggers:** list, create, update, and archive anomaly detection triggers.
* **Dashboards:** list, create, and update your app's [dashboards](/cli/dashboards).
* **Apps:** list your applications, find an app by name, and inspect its users, notifiers, namespaces, dashboards, and deploy markers.
* **Project configuration:** create a [project-local config](/cli/configuration) so commands run in a repository default to the right organization.
* **Agent skill:** install the bundled AppSignal skill into your AI agent, update it, and check whether it's current.

## Global flags

These flags work on every command:

| Flag                      | Description                                                                                           |
| ------------------------- | ----------------------------------------------------------------------------------------------------- |
| `--output <value>` (`-o`) | Render results as `human` (the default) or `json`. `--format` is a synonym.                           |
| `--help` (`-h`)           | Show usage, subcommands, and options for any command (for example, `appsignal-cli logs tail --help`). |

You can pass `--output` (or `--format`) before or after the subcommand. Command results go to standard output in the format you choose; status messages always go to standard error, so a `--output json` stream stays valid JSON that you can pipe into another tool.

## Installation

The CLI runs on macOS and Linux, on both Intel (`x86_64`) and Apple Silicon / ARM (`arm64`) machines. Linux distributions based on musl, such as Alpine, are supported too.

<Tabs>
  <Tab title="Homebrew">
    Install the formula. Homebrew taps `appsignal/appsignal-cli` automatically:

    ```sh theme={null}
    brew install appsignal/appsignal-cli/appsignal-cli
    ```

    To upgrade later, run:

    ```sh theme={null}
    brew upgrade appsignal-cli
    ```
  </Tab>

  <Tab title="Install script (macOS & Linux)">
    Install the latest release with the one-liner below. It needs super-user privileges to install the binary on your system path, and verifies the download against the published `SHA256SUMS` manifest before installing:

    ```sh theme={null}
    curl -sSL https://github.com/appsignal/appsignal-cli/releases/latest/download/install.sh | sudo sh
    ```

    Re-run the same command at any time to update to the latest release.
  </Tab>
</Tabs>

<Note>
  Prefer not to pipe a script into your shell? Download the binary for your platform directly from the [latest release](https://github.com/appsignal/appsignal-cli/releases/latest/).
</Note>

### Verify the installation

Check that the CLI is on your `PATH`:

```sh Shell theme={null}
appsignal-cli --version
```

Then run `appsignal-cli about` for an overview of your setup, including its version, endpoint, default organization, and authentication status:

```sh Shell theme={null}
appsignal-cli about
```

Before you authenticate, it'll show `Auth: Not authenticated` and point you at the commands to run next.

## Next steps

You've installed the CLI, but it can't reach your data until you sign in. Head to [Authentication](/cli/authentication) to connect the CLI to your AppSignal account.