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

# CLIの概要

> lim CLI の導入方法と、private beta 版を含む全体のコマンド体系。

# lim CLI

lim CLIは、ターミナルから会計操作を行うためのコマンドラインツールです。AI Agentとの連携にも最適です。

## インストール

<CodeGroup>
  ```bash npm theme={null}
  npm install -g @lim-labs/lim
  ```

  ```bash pnpm theme={null}
  pnpm add -g @lim-labs/lim
  ```

  ```bash private beta theme={null}
  npm install -g @lim-labs/lim-beta
  lim-beta doctor
  ```
</CodeGroup>

```bash theme={null}
lim --version
# => lim v0.1.0
```

staging 検証では `lim-beta` を使用します。

```bash theme={null}
lim-beta --version
lim-beta env
lim-beta auth login
```

## 認証

```bash theme={null}
# ブラウザでOAuth認証
lim auth login

# 認証状態の確認
lim auth whoami

# ログアウト
lim auth logout
```

## コマンド体系

| 機能群       | コマンド                                                                                          | 詳細                                                                                                                                                                                                 |
| --------- | --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 認証と環境確認   | `auth`, `doctor`, `env`                                                                       | [詳細](/ja/cli/auth-and-diagnostics)                                                                                                                                                                 |
| 基本会計      | `add`, `journals`, `reports`, `companies`, `accounts`, `dashboard`, `stats`                   | [add](/ja/cli/add), [journals](/ja/cli/journals), [reports](/ja/cli/reports), [companies](/ja/cli/companies), [accounts](/ja/cli/accounts), [dashboard](/ja/cli/dashboard), [stats](/ja/cli/stats) |
| 入出金と証憑    | `invoices`, `payments`, `bank`, `docs`                                                        | [詳細](/ja/cli/invoices-and-payments), [bank](/ja/cli/banking), [documents](/ja/cli/documents)                                                                                                       |
| 既存データ移行   | `import`, `export`                                                                            | [詳細](/ja/cli/import-and-export)                                                                                                                                                                    |
| 人事・経費・承認  | `employees`, `worker-contracts`, `payroll`, `expenses`, `approvals`, `members`, `withholding` | [詳細](/ja/cli/people-and-payroll)                                                                                                                                                                   |
| 派遣管理      | `dispatch`, `workers`                                                                         | [詳細](/ja/cli/dispatch-and-workers)                                                                                                                                                                 |
| 締め処理と内部統制 | `close`, `reopen`, `fx`, `labels`, `tax-codes`, `events`                                      | [詳細](/ja/cli/periods-and-compliance)                                                                                                                                                               |
| 将来計画と自動処理 | `contracts`, `assets`, `scenarios`, `accruals`                                                | [詳細](/ja/cli/planning-and-automation)                                                                                                                                                              |

## グローバルオプション

すべてのコマンドで使用できるオプションです:

```bash theme={null}
# 出力フォーマットの指定
lim reports tb --format json

# 会社の指定（デフォルトはアクティブ会社）
lim journals list --company comp_01J7...

# 詳細出力
lim add "AWS 11000円" --verbose

# ヘルプの表示
lim --help
lim add --help
```

## 設定ファイル

lim の設定は `~/.config/lim/config.json` に保存されます:

```json theme={null}
{
  "activeCompanyId": "01926f3a-1234-7abc-8def-000000000001",
  "channel": "beta",
  "apiUrl": "https://staging-api.uselim.com",
  "webUrl": "https://staging.uselim.com"
}
```

## 自動補完

```bash theme={null}
# Bashの場合
lim completion bash >> ~/.bashrc

# Zshの場合
lim completion zsh >> ~/.zshrc
```

## AI Agentからの利用

lim CLIはAI Agentからの呼び出しに最適化されています。`--format json` を使うことで、構造化されたデータを取得できます:

```bash theme={null}
lim reports tb --format json | jq '.accounts[] | select(.balance > 0)'
```

<Tip>
  MCPサーバーを使えば、AI AgentがlimのAPIを直接呼び出せます。CLIを経由する必要はありません。詳しくは
  [MCPサーバー](/ja/agents/mcp-server) を参照してください。
</Tip>

## 次のステップ

<CardGroup cols={2}>
  <Card title="lim add" icon="plus" href="/ja/cli/add">
    自然言語で仕訳を追加。
  </Card>

  <Card title="クイックスタート" icon="rocket" href="/ja/quickstart">
    5分で最初の仕訳。
  </Card>
</CardGroup>

## staging 検証の最短フロー

```bash theme={null}
lim-beta doctor
lim-beta auth login
lim-beta companies list
lim-beta companies use <company-id>
lim-beta accounts list
lim-beta reports tb --from 2026-01-01 --to 2026-12-31
```
