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

# MoleSignal CLI

> Read logs, metrics, traces, and incidents, report deployments, upload source maps and symbols, and connect AI agent tools to MoleSignal from a terminal with the molesignal command.

The MoleSignal CLI is the `molesignal` command, published on npm as `@molesignal/cli`. It
signs in to a MoleSignal instance and then:

* reads and follows logs, runs SQL and PromQL, draws traces as waterfalls, and sums up APM
  services;
* lists incidents and who is on call, acknowledges and resolves incidents, runs synthetic checks,
  and carries out approved changes;
* reports deployments, uploads RUM source maps and symbols, and sends the output of scripts to a
  stream, in CI;
* calls any tool of MoleSignal's catalogue;
* serves MoleSignal's MCP tools over stdio, so that Claude Code, Cursor, Codex, VS Code, and
  Gemini CLI can start it as an MCP server.

Reads and changes go through MoleSignal's tools, so the signed-in user's permissions, the
organization's Tool Policy, and its approvals apply to the CLI as they apply to Mole Agent.
Reporting deployments, uploading debug artifacts, and sending logs go to MoleSignal's API and
take an API token.

## Requirements

* Node.js 20 or later.
* A MoleSignal instance reachable from the machine, and an account in it.

## Install

```bash theme={null}
npm install -g @molesignal/cli
```

Check the installation:

```bash theme={null}
molesignal --version
```

Each command also runs without installing:

```bash theme={null}
npx -y @molesignal/cli --help
```

## Get started

**1. Sign in**

```bash theme={null}
molesignal login --url https://molesignal.example.com
```

The browser opens on the MoleSignal authorization page. Click **Authorize** there. See
[Sign in](https://docs.molesignal.com/en-US/cli/sign-in.md).

**2. Check the setup**

```bash theme={null}
molesignal doctor
```

**3. Read logs**

```bash theme={null}
molesignal logs app_logs -f
```

See [Read and follow logs](https://docs.molesignal.com/en-US/cli/logs.md).

## Commands

| Group | Commands |
| - | - |
| Sign-in | `login`, `logout`, `profiles`, `use`, `status`, `whoami`, `doctor`. See [Sign in](https://docs.molesignal.com/en-US/cli/sign-in.md). |
| Logs and queries | `streams`, `logs`, `query`, `fields`. See [Read and follow logs](https://docs.molesignal.com/en-US/cli/logs.md). |
| Metrics, traces, and services | `metrics`, `traces`, `services`, `search-jobs`. See [Metrics, traces, and services](https://docs.molesignal.com/en-US/cli/observe.md). |
| On-call and changes | `incidents`, `oncall`, `approvals`, `annotate`, `synthetics`. See [Incidents and changes](https://docs.molesignal.com/en-US/cli/changes.md). |
| Releases and data | `deploy`, `source-maps`, `symbols`, `send`, `run`. See [CI and releases](https://docs.molesignal.com/en-US/cli/ci.md). |
| Tools and setup | `tools`, `call`, `mcp`, `open`, `completion`. See [Call any tool](https://docs.molesignal.com/en-US/cli/tools.md) and [Serve MCP over stdio](https://docs.molesignal.com/en-US/cli/mcp.md). |

`molesignal <command> --help` describes a command and its options. Every option is also in the
[command reference](https://docs.molesignal.com/en-US/cli/reference.md).


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