> ## 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.

# Agent skill

> Install the bundled AppSignal skill into Claude, Codex, or OpenCode so your AI coding agent can drive the CLI.

The CLI bundles an AppSignal agent skill: a set of instructions that teaches an AI coding agent how to use `appsignal-cli` to inspect your AppSignal data. Installing it writes a `SKILL.md` into the agent's skills directory, so the agent knows when to reach for the CLI and how to read its JSON output.

<Note>
  The skill teaches an agent to run the CLI, so the agent acts as you. Make sure the CLI is [authenticated](/cli/authentication) on the machine where the agent runs.
</Note>

<h2 id="install-the-skill">
  Install the skill
</h2>

```sh Shell theme={null}
appsignal-cli skill install
```

By default this installs the skill for OpenCode. Choose a different agent, or install for all of them, with `--target`:

```sh Shell theme={null}
# Claude
appsignal-cli skill install --target claude

# Codex
appsignal-cli skill install --target codex

# Every supported agent
appsignal-cli skill install --target all
```

<h3 id="supported-agents">
  Supported agents
</h3>

Each target installs the same skill into that agent's default skills directory:

| Target | Installs to |
| - | - |
| `opencode` (the default) | `~/.agents/skills/appsignal/SKILL.md` |
| `codex` | `$CODEX_HOME/skills/appsignal/SKILL.md`, or `~/.codex/skills/appsignal/SKILL.md` when `$CODEX_HOME` is unset |
| `claude` | `~/.claude/skills/appsignal/SKILL.md` |
| `all` | All of the directories above |

Two more flags adjust where and how the skill is installed:

| Flag | Description |
| - | - |
| `--dir <path>` | Install into this skills root directory instead of the target's default |
| `--force` | Overwrite an existing installed skill |

`skill update` and `skill status` accept the same `--target` and `--dir` flags, so you can update or check a skill installed in a custom location.

<h2 id="keep-the-skill-up-to-date">
  Keep the skill up to date
</h2>

An installed skill records the CLI version that produced it. After you upgrade `appsignal-cli`, refresh your installs to the bundled version:

```sh Shell theme={null}
appsignal-cli skill update
```

Like `install`, `update` acts on OpenCode by default; pass `--target` to update a different agent or `all` of them.

```sh Shell theme={null}
appsignal-cli skill update --target all
```

<h2 id="check-installation-status">
  Check installation status
</h2>

To see whether your installed skills are current, outdated, or missing:

```sh Shell theme={null}
appsignal-cli skill status
```

`status` checks all supported agents by default, so you get one list covering OpenCode, Codex, and Claude. Pass `--target` to narrow it to a single agent.

<h2 id="next-steps">
  Next steps
</h2>

The skill lets an agent run the CLI from your shell. For agents that talk to AppSignal directly over HTTP instead, see [AppSignal MCP](/mcp-server).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.