freee-api

freee-cli

freee API をコマンドラインから操作できる CLI ツールです。

freee-mcp をベースに、MCP 層を CLI に置き換えたフォーク版です。

特徴

• freee API を直接コマンドラインから呼び出し
• 複数 API 対応: 会計・人事労務・請求書・工数管理・販売の5つの freee API をサポート
• OAuth 2.0 + PKCE: セキュアな認証フロー、トークン自動更新
• 複数事業所対応: 事業所の動的切り替えが可能
• OpenAPI スキーマによるパスバリデーション

インストール

npm install -g freee-cli

または npx で直接実行:

npx freee-cli configure

セットアップ

1. freee アプリの作成

freee Developer でアプリを作成し、以下を設定:

• コールバック URL: http://127.0.0.1:54321/callback

2. 初期設定

freee configure

対話式で以下を設定します:

1. Client ID / Client Secret の入力
2. ブラウザでの OAuth 認証
3. デフォルト事業所の選択

使い方

認証管理

freee auth status    # 認証状態を確認
freee auth login     # 再認証
freee auth logout    # 認証情報をクリア

ユーザー・事業所

freee me                  # 現在のユーザー情報
freee companies           # 事業所一覧（* が現在の事業所）
freee company get         # 現在の事業所
freee company set 12345   # 事業所を切り替え

API 呼び出し

# GET
freee get accounting /api/1/deals '{"company_id":"123","limit":"3"}'

# POST
freee post accounting /api/1/deals '{"company_id":123,"issue_date":"2024-01-01","type":"income"}'

# PUT
freee put accounting /api/1/deals/456 '{"company_id":123,"issue_date":"2024-02-01"}'

# DELETE
freee delete accounting /api/1/deals/456

# PATCH
freee patch accounting /api/1/deals/456 '{"company_id":123,"issue_date":"2024-03-01"}'

API エンドポイント一覧

freee paths              # 全サービスのエンドポイント一覧
freee paths accounting   # 会計APIのみ

サービス一覧

サービス	説明
accounting	freee会計 API
hr	freee人事労務 API
invoice	freee請求書 API
pm	freee工数管理 API
sm	freee販売 API

jq との組み合わせ

# 取引一覧から金額だけ抽出
freee get accounting /api/1/deals '{"company_id":"123"}' | jq '.deals[].amount'

# 勘定科目の名前一覧
freee get accounting /api/1/account_items '{"company_id":"123"}' | jq '.account_items[].name'

設定ファイル

設定は ~/.config/freee-cli/ に保存されます:

• config.json - OAuth 認証情報、事業所設定
• tokens.json - アクセストークン、リフレッシュトークン

ライセンス

Apache-2.0 (原作: freee/freee-mcp)