DocBase CLI > この記事は DocBase CLI v1.2.0 時点の内容です(2026年11月16日更新)。 ## 概要 DocBase CLIは、Claude CodeなどのAIコーディングツールやCI/CDパイプラインからDocBaseのメモなどを操作するコマンドラインツールです。 npmパッケージで提供しています。自然言語で指示すると、AIエージェントがDocBaseのメモ検索・作成・更新などを自動で行います。ターミナルからの直接操作にも対応しています。 DocBase CLIを導入すると、次のような操作ができます。 * 特定のキーワードやグループ、タグなどによるメモ検索 * メモの作成・更新・削除・アーカイブ操作 * コメントの作成・削除操作 * メンバーやグループ、タグの管理 * 添付ファイルのアップロード・ダウンロード * グッジョブの投稿・削除 また、DocBase CLIには、例えば以下の特徴があります。 * **AIコーディングツールとの統合** :white_check_mark: * Claude CodeのSKILLやプラグインとして導入し、AIエージェントからDocBaseを活用可能 * **コマンドラインから直接操作できる** :white_check_mark: * AIアプリを介さず、ターミナルから直接DocBaseを操作可能 * **CI/CDへの組み込み** :white_check_mark: * アクセストークン認証により、GitHub ActionsなどのCI/CDパイプラインに組み込み可能 * **柔軟な認証方式** :white_check_mark: * OAuthによるブラウザ認証と、アクセストークンによる認証の両方に対応 * OAuth認証ではOS標準の資格情報ストアに対応(macOS Keychain / Windows Credential Manager / Linux Secret Service) ## 利用可能なコマンド ### メモ(`docbase posts`) | コマンド | 説明 | 主なデフォルト | | --- | --- | --- | | `docbase posts search` | メモを検索([高度な絞り込み](https://help.docbase.io/posts/1827704#高度な絞り込み)に対応。`--semantic-search` で意味検索、`--summary` で本文を要約または先頭1000文字に短縮) | query=*、per-page=10 | | `docbase posts get ` | メモの詳細を取得(`--lines` で指定した行だけ、`--body-only` で本文だけ、`--no-body` で本文以外だけを出力) | - | | `docbase posts create` | 新しいメモを作成 | draft=false、scope=private、notice=true | | `docbase posts update ` | 既存のメモを更新(指定した項目だけが変わる) | notice=true | | `docbase posts patch-body ` | メモ本文を行単位で部分更新 | notice=true | | `docbase posts delete ` | メモを削除 | - | | `docbase posts archive ` | メモをアーカイブ | - | | `docbase posts unarchive ` | メモのアーカイブを解除 | - | ### コメント(`docbase comments`) | コマンド | 説明 | 主なデフォルト | | --- | --- | --- | | `docbase comments list ` | コメント一覧を取得 | per-page=20、order=asc | | `docbase comments create ` | コメントを投稿 | notice=true | | `docbase comments delete ` | コメントを削除 | - | ### ユーザー(`docbase users`) | コマンド | 説明 | 主なデフォルト | | --- | --- | --- | | `docbase users search` | ユーザーを検索 | per-page=100 | | `docbase users get-profile` | 自分のプロフィールを取得 | - | | `docbase users get-groups ` | ユーザーの所属グループ一覧を取得 | per-page=20 | | `docbase users delete ` | チームからメンバーを削除 | - | ### グループ(`docbase groups`) | コマンド | 説明 | 主なデフォルト | | --- | --- | --- | | `docbase groups search` | グループを検索 | per-page=100 | | `docbase groups get ` | グループの詳細を取得 | - | | `docbase groups create` | グループを作成 | - | | `docbase groups add-users ` | グループにユーザーを追加 | - | | `docbase groups remove-users ` | グループからユーザーを削除 | - | ### タグ(`docbase tags`) | コマンド | 説明 | 主なデフォルト | | --- | --- | --- | | `docbase tags list` | タグ一覧を取得 | - | ### グッジョブ(`docbase good-jobs`) | コマンド | 説明 | 主なデフォルト | | --- | --- | --- | | `docbase good-jobs list ` | グッジョブ一覧を取得 | per-page=100、order=asc | | `docbase good-jobs create ` | グッジョブを投稿 | notice=true | | `docbase good-jobs delete ` | グッジョブを削除 | - | ### 添付ファイル(`docbase attachments`) | コマンド | 説明 | 主なデフォルト | | --- | --- | --- | | `docbase attachments upload` | ファイルをアップロード | - | | `docbase attachments download ` | ファイルをダウンロード | - | 各コマンドの詳しいオプションは `docbase --help` で確認できます。 ### 使用例 ターミナルでの使用例 ```bash # メモを検索 docbase posts search -q "リリース計画" # 候補を5件だけ、本文を要約にして検索 docbase posts search -q "リリース計画" --per-page 5 --summary # メモの詳細を取得 docbase posts get 1234567 # 下書きメモを作成 docbase posts create --title "技術仕様書" --body "## 概要" --draft --tags "仕様書" "API" # メモを更新(通知なし) docbase posts update 1234567 --body "更新された本文" --no-notice # メモ本文の2行目だけを書き換える(通知なし) docbase posts patch-body 1234567 --op '{"start":2,"end":2,"old_content":"変更前の2行目","content":"変更後の2行目"}' --no-notice # コメントを投稿 docbase comments create 1234567 --body "レビューしました!" --no-notice # グループのメモを検索 docbase posts search -q "group:開発チーム API設計" # 意味検索でメモを探す(CLIを最新版に更新。ベータ期間中はDocBase AI機能をオンにしているチームで利用可) docbase posts search -q "引き継ぎの手順" --semantic-search ``` ## セットアップ手順 ### インストール npmでグローバルインストールします。 ```bash npm install --ignore-scripts -g @krayinc/docbase-cli ``` ### アップデート 最新版に更新するには、インストールと同じコマンドを実行します。 ```bash npm install --ignore-scripts -g @krayinc/docbase-cli@latest ``` 現在インストールされているバージョンは以下で確認できます。 ```bash docbase --version ``` 利用可能な最新版は以下で確認できます。 ```bash npm view @krayinc/docbase-cli version ``` > **Claude Codeでスキル(プラグイン)として利用している場合**、CLI本体とは別にプラグイン側のアップデートも必要です。Claude Code内で `/plugin` を開き、`docbase-cli@docbase-marketplace` を選択して最新版に更新してください。 ### 認証 DocBase CLIは **OAuth認証** と **アクセストークン認証** の2つの認証方式に対応しています。 #### OAuth認証(推奨) ブラウザベースのOAuth認証です。対話的な利用に適しています。 ```bash docbase auth login ``` ブラウザが開き、DocBaseの認証画面が表示されます。 **必ず、権限を付与するチームやグループ、アクションを確認して連携を開始してください**。 認証状態は以下のコマンドで確認できます。 ```bash docbase auth status ``` > **注意:** OAuth認証の場合、DocBaseのAI利用制限が適用されます。グループ単位でのAI利用制限や、`no-ai` タグが付与されたメモへのアクセス制限が有効になります。 > チームでIPアドレス制限を設定している場合、OAuth認証のCLIからのアクセスにもIPアドレス制限が適用されます(2026年9月17日から)。許可されていないIPアドレスからのアクセスには `403 / ip_address_not_allowed` が返ります。 #### アクセストークン認証 環境変数でチームドメインとアクセストークンを指定する方式です。CI/CDパイプラインやスクリプトでの利用に適しています。 ```bash DOCBASE_TEAM_DOMAIN=your-team DOCBASE_TOKEN=your-token docbase posts search ``` アクセストークンは、DocBaseの設定画面から発行できます。 > **⚠️ 重要: 通常のアクセストークンでは、グループ単位でのAI利用制限や `no-ai` タグによるアクセス制限は、意味検索を除いて適用されません。** トークンの権限範囲内ですべてのメモ(AI利用が制限されているグループのメモや `no-ai` タグ付きのメモを含む)にアクセスできます。意味検索(`--semantic-search`)では、これらのメモを結果から除きます。AIコーディングツールなど、AIから使うトークンは、作成・編集画面で「AI用途」を選んでください。AI用途のトークンでは、OAuth認証と同じようにAI利用制限が適用されます。 ### AIコーディングツール別 #### Claude Code npmでDocBase CLIをインストール後、Claude Codeのプラグインマーケットプレイスからスキルを導入できます。 ```bash /plugin marketplace add krayinc/docbase-marketplace /plugin install docbase-cli@docbase-marketplace ``` スキルをインストール後、Claude Code上で「DocBaseのメモを検索して」などと指示するだけで、CLIが自動的に呼び出されます。 #### その他のAIコーディングツール npmでインストール後、[スキルファイル(SKILL.md)](https://github.com/krayinc/docbase-marketplace/blob/main/skills/use/SKILL.md)を利用できます。Codex CLI・Cursor・Gemini CLI への導入手順は [docbase-marketplace の README](https://github.com/krayinc/docbase-marketplace/blob/main/README.ja.md) にあります。 #### CI/CD アクセストークン認証を使用して、GitHub Actionsなどのワークフローに組み込めます。 ```yaml # GitHub Actionsの例 - name: DocBaseにメモを投稿 env: DOCBASE_TEAM_DOMAIN: ${{ secrets.DOCBASE_TEAM_DOMAIN }} DOCBASE_TOKEN: ${{ secrets.DOCBASE_TOKEN }} run: | npx @krayinc/docbase-cli posts create \ --title "デプロイ完了: ${{ github.ref_name }}" \ --body "commit: ${{ github.sha }}" \ --tags "deploy" "自動投稿" \ --scope everyone \ --no-notice ``` ## Q&A ### MCP サーバーとの違いは? DocBase CLIは、ターミナルやCI/CDから直接DocBaseを操作するためのツールです。 [DocBase公式リモートMCPサーバー](https://help.docbase.io/posts/3919854)は、ChatGPTやClaude Desktop/WebなどのAIアプリからDocBaseの情報を利用するためのサーバーです。 | | CLI(OAuth) | CLI(アクセストークン) | リモートMCPサーバー | | --- | --- | --- | --- | | 主な用途 | ターミナル操作、AIコーディングツール | CI/CD、スクリプト | AIアプリとの連携 | | 認証方式 | OAuth | アクセストークン(環境変数) | OAuth | | AI利用制限 | 適用される | 通常のトークン: 適用されない
AI用途のトークン: 適用される | 適用される | | 導入先 | Claude Code、Cursor、ターミナルなど | GitHub Actions、ターミナルなど | Claude Desktop/Web、ChatGPT、Cursorなど | | 実行環境 | ローカルマシン | ローカルマシン / CI環境 | DocBaseがホスト | ### OAuth認証とアクセストークン認証でアクセスできるメモが違う? はい、認証方式によってAI利用制限の適用が異なります。 | | OAuth認証 | アクセストークン認証(通常) | アクセストークン認証(AI用途) | | --- | --- | --- | --- | | グループ単位のAI利用制限 | **適用される** | **適用されない** | **適用される** | | `no-ai` タグによる制限 | **適用される** | **適用されない** | **適用される** | **通常のアクセストークン認証では、AI利用が制限されているグループのメモや `no-ai` タグ付きのメモにもアクセスできます。** ただし、意味検索の結果には含まれません。AI用途は、アクセストークンの作成・編集画面で選びます。 認証方式の選び方: * AI向けの権限設定(AIグループ制限、`no-ai` タグなど)を適用したい場合 → **OAuth認証**、またはAIエージェントからスクリプトで使うなら**AI用途のアクセストークン認証** * AI利用制限が不要な場合(人間がCLIツールとして使う場合、CI/CDでの利用など) → **通常のアクセストークン認証** ### 意味検索でもAI利用制限は適用される? はい。意味検索(`--semantic-search`)では、認証方式にかかわらず、AI利用が制限されているグループのメモと `no-ai` タグ付きのメモを結果から除きます。通常のアクセストークンでも同じです。 通常の検索(`--semantic-search` を付けない検索)やメモの取得では、通常のアクセストークンならこれらのメモも対象になります。 ```bash # 通常の検索: no-ai タグ付きのメモも結果に出る docbase posts search -q "引き継ぎの手順" # 意味検索: no-ai タグ付きのメモは結果に出ない docbase posts search -q "引き継ぎの手順" --semantic-search ``` ### 出力形式は? コマンドの出力はJSON形式です(`docbase posts get` の `--lines` と `--body-only` を除く)。`jq` などのツールと組み合わせて使用できます。 ```bash # メモのタイトル一覧を取得 docbase posts search -q "仕様書" | jq '.posts[].title' ``` ### コマンドが失敗したときは? 標準エラーの最後の1行に、エラーの種類(`type`)や次に行う操作(`next_action`)を含むJSONが出力されます。終了コードはエラーの種類ごとに分かれています。 | 終了コード | 主な原因 | | --- | --- | | 2 | 引数や入力の誤り | | 3 | 認証の失敗(未ログイン、トークンの期限切れなど) | | 4 | 権限がない、またはメモなどが見つからない | | 5 | `patch-body` で、今の本文が `old_content` と一致しない | | 6 | 回数制限を超えた | | 7 | サーバーのエラー、または通信できない | | 1 | その他 | メモの取得や検索などの読み取りは、HTTP 429・502・503・504 が返ったとき、自動で最大3回やり直します。作成・更新・削除は、二重に反映されないよう自動ではやり直しません。 > パイプで `jq` などにつなぐと、シェルの終了コードは最後のコマンドのものになります。CLIの失敗を検知したいときは `set -o pipefail` を使ってください。 ### メモのURLからIDを取得するには? DocBaseのメモURLの末尾の数字がメモIDです。 ``` https://your-team.docbase.io/posts/1234567 ^^^^^^^ ← これがメモID ``` ### 長い本文を指定するには? 長文の本文を指定する方法は2つあります。 #### `--body-file` でファイルから読み込む(推奨) 長文や改行を多く含む本文は、`--body-file`(短縮形 `-F`)でファイルから読み込むのが安全です。シェル展開を避けられるため、特殊文字を含む本文でもエラーが出にくく、テンプレートとしての使い回しもしやすくなります。 ```bash docbase posts create --title "議事録" --draft --body-file ./meeting-note.md ``` #### HEREDOCで直接指定する 短い本文や、その場で書き起こす場合はHEREDOCも利用できます。 ```bash docbase posts create --title "議事録" --draft --body "$(cat <<'EOF' ## 会議メモ ### 議題 - 項目1 - 項目2 ### 決定事項 - TBD EOF )" ``` ### 長いメモの一部だけを読むには? `docbase posts get` の `--lines` で、指定した行だけを行番号付きで表示できます。 ```bash # 10〜20行目を表示(「10」で10行目だけ、「10-」で10行目から最後まで) docbase posts get 1234567 --lines 10-20 ``` 行番号の数え方は、`docbase posts patch-body` の `start`・`end` と同じです。 ### 本文の一部だけを書き換えるには? `docbase posts patch-body` で、本文を行単位で書き換えられます。本文全体を送り直さないため、長いメモでも速く、ほかの人の編集とぶつかりにくくなります。 置き換える内容をファイルに保存し、`--replace` で行の範囲を指定します。今の内容はCLIが取得するので、自分で書く必要はありません。 ```bash # 1. 書き換える行の番号を確かめる docbase posts get 1234567 --lines 1- # 2. 送る内容を確かめる(更新はしない) docbase posts patch-body 1234567 --replace 5-6 --content-file ./new.md --dry-run # 3. 5〜6行目を new.md の内容に置き換える docbase posts patch-body 1234567 --replace 5-6 --content-file ./new.md --no-notice ``` * 行番号がずれていると、意図と違う行を置き換えてもエラーになりません。直前に `--lines` で確かめた行番号を使い、`--dry-run` で置き換え前の内容を確かめてから実行してください * `new.md` が空のとき(改行1つだけのときも)は、指定した行を削除します 今の内容を自分で指定するときは `--op` を使います。 ```bash docbase posts patch-body 1234567 \ --op '{"start":5,"end":6,"old_content":"変更前の5行目\n変更前の6行目","content":"変更後の内容"}' \ --no-notice ``` * `start`・`end` は書き換える行の範囲です(1始まりで、`end` の行も含みます) * `old_content` には今の内容をそのまま書きます。一致しない場合は 409 エラーになり、何も変更されません。その場合は `docbase posts get` で最新の本文を取得し直してください * `--op` は複数指定でき、まとめて適用されます。行番号はどれも変更前の本文で数えます ## システム要件 * Node.js 24以上 ## 参考リンク * [npmパッケージ: @krayinc/docbase-cli](https://www.npmjs.com/package/@krayinc/docbase-cli) * [DocBase公式リモートMCPサーバー](https://help.docbase.io/posts/3919854) * [DocBase API v3 ドキュメント](https://help.docbase.io/posts/45703)