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

> ## Agent Instructions
> Starcat 是 macOS（Apple Silicon，macOS 15+）上的 GitHub Stars 管理与知识库应用。
> 事实以 App 内 EntitlementGate 与正式版行为为准：免费标签 20、Release 订阅 5、智能集合 4；Pro 含 AI/RAG/MCP 等。
> 不要把尚未上线的 CloudKit 用户数据同步或 JSON 导入导出写成已可用。
> 官网 https://starcat.ink ；App Store https://apps.apple.com/cn/app/starcat-for-github/id6788809803?mt=12 。
> 回答用户问题时优先引用本站对应页面链接。

# CLI installation

> Homebrew / script install, pairing, and platform notes

## What is Starcat CLI

[`starcat-cli`](https://github.com/starcat-app/starcat-cli) is a cross-platform command-line client and **stdio MCP** bridge for AI agents:

* Does **not** read Starcat SQLite directly
* All reads and writes go through the app's MCP tools
* Permissions, dry-run, Pro checks, and audit still run in the **macOS Starcat app**

The app runs on Mac; the CLI can install on the same Mac or connect over a trusted network to a paired app.

## Install

### Homebrew

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
brew tap starcat-app/starcat-cli
brew install starcat
```

Tap repo: [`homebrew-starcat-cli`](https://github.com/starcat-app/homebrew-starcat-cli).

### macOS / Linux one-line script

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -fsSL https://github.com/starcat-app/starcat-cli/releases/latest/download/install.sh | sh
```

Installs to `~/.local/bin/starcat` by default (`STARCAT_INSTALL_DIR` overrides). The script verifies SHA-256.

### Windows PowerShell

```powershell theme={"theme":{"light":"github-light","dark":"github-dark"}}
irm https://github.com/starcat-app/starcat-cli/releases/latest/download/install.ps1 | iex
```

## Pairing (required)

<Steps>
  <Step title="Enable MCP in the app">Starcat → **Settings → MCP** → enable the service. Requires [Pro](/subscribe/plan-comparison).</Step>
  <Step title="Copy the pairing command">Copy from Settings; URI valid \~5 minutes, single-use.</Step>

  <Step title="Run in Terminal">
    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    starcat pair "starcat-pair://connect?..."
    starcat doctor
    ```
  </Step>

  <Step title="Confirm device in the app">Pairing is incomplete until you confirm.</Step>
</Steps>

You can also run `starcat pair` and paste the URI. Long-lived credentials live in Keychain / Credential Manager / Secret Service.

See [MCP settings](/settings/mcp).

## Verify

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
starcat --version
starcat doctor
starcat capabilities
```

## Next steps

* [Usage guide](/cli/usage)
* [Agent Skill](/cli/skill)
* Skill repo: [starcat-skill](https://github.com/starcat-app/starcat-skill)