メインコンテンツへスキップ

​
Linkly AI CLI の紹介

Linkly AI CLI は、Linkly AI Desktop の MCP サービスに接続して、ターミナルからローカルドキュメントを検索、閲覧、読み取りできるコマンドラインツールです。同時に、AI Agent（Claude Desktop、Cursor など）と Linkly AI の間のブリッジとしても機能します。

ターミナル検索

コマンドラインから直接ドキュメントを検索。開発者やギークユーザーに最適です

MCP ブリッジ

stdio MCP モードで実行し、Claude Desktop、Cursor などの AI ツールから Linkly AI を呼び出せます

​
インストール

ターミナルで以下を実行：
curl -sSL https://updater.linkly.ai/cli/install.sh | sh
インストール完了後、インストールを確認します： 
linkly --version
CLI を実行する前に Linkly AI Desktop アプリを起動する必要があります。CLI は ~/.linkly/port ファイルを通じてデスクトップアプリの MCP サービスを自動的に検出して接続します。

​
使い方

CLI は search → outline → read の段階的なワークフローに従います：まず検索で対象ドキュメントを見つけ、次にアウトラインで構造を把握し、最後に具体的な内容を読み取ります。

​
接続ステータスの確認

linkly status
Linkly AI Desktop の実行ステータス、バージョン番号、インデックス済みドキュメント数、インデックスステータスを返します。

​
ドキュメント検索

linkly search "キーワードまたはフレーズ"
ローカルドキュメントを検索し、最も関連性の高い結果リストを返します。タイトル、パス、マッチ度、内容スニペットが含まれます。 よく使うパラメータ： 
# 返却件数を制限（デフォルト 20、最大 50）
linkly search "API 設計" --limit 5

# ドキュメントタイプでフィルター
linkly search "会議議事録" --type pdf,docx

# JSON 形式で出力（スクリプト処理に適しています）
linkly search "予算報告" --json

​
ドキュメントアウトラインの表示

linkly outline <DOC_ID>
ドキュメントの構造化されたアウトラインとメタデータを取得します。DOC_ID は検索結果から取得します。複数のドキュメントを一度に表示できます： 
linkly outline id1 id2 id3
アウトライン機能は Markdown と DOCX のドキュメントで最も効果的です。これらの形式の見出し構造を解析できます。プレーンテキストやブックマークのない PDF の場合は、read コマンドを直接使用することをお勧めします。

​
ドキュメント内容の読み取り

linkly read <DOC_ID>
ドキュメントの完全な内容を読み取り、行番号付きのテキストを出力します。長いドキュメントの場合、ページ分割して読み取れます： 
# 50 行目から 100 行を読み取る
linkly read <DOC_ID> --offset 50 --limit 100
ページ分割戦略： デフォルトでは 1 回に 200 行を読み取ります（最大 500 行）。長いドキュメントの場合、--offset を調整して段階的に読み取ります： 
linkly read <DOC_ID> --offset 1 --limit 200    # 第 1-200 行
linkly read <DOC_ID> --offset 201 --limit 200  # 第 201-400 行
linkly read <DOC_ID> --offset 401 --limit 200  # 第 401-600 行

​
MCP モード

linkly mcp
stdio MCP サーバーモードで実行し、Linkly AI のツールを MCP 互換の AI クライアントに公開します。 Claude Desktop などのローカル AI アプリの設定： 以下の内容を Claude Desktop などのアプリの設定ファイルに追加してください：
~/.config/Claude/claude_desktop_config.json を編集：
{
  "mcpServers": {
    "linkly-ai": {
      "command": "linkly",
      "args": ["mcp"]
    }
  }
}
Cursor の設定： Cursor で Settings → MCP Servers → Add Server を開き、以下を追加：
  • Name: linkly-ai
  • Command: linkly mcp

​
CLI のアップデート

linkly self-update
自動的に最新バージョンを確認してアップデートします。CLI は起動時にバックグラウンドで更新を確認し、新しいバージョンがある場合はこのコマンドの実行を促します。

​
パラメータ説明

​
グローバルオプション

オプション説明
--endpoint <URL>MCP エンドポイントを指定（デフォルトは ~/.linkly/port から自動検出）
--jsonJSON 形式で出力（スクリプトや自動化に適しています）
-V, --versionCLI バージョン番号を表示
-h, --helpヘルプ情報を表示

​
search パラメータ

パラメータ説明デフォルト値
<QUERY>検索キーワードまたはフレーズ（必須）—
--limit <N>最大返却結果数20
--type <TYPES>ドキュメントタイプでフィルター（カンマ区切り）全部

​
outline パラメータ

パラメータ説明デフォルト値
<ID...>ドキュメント ID（必須、複数指定可）—

​
read パラメータ

パラメータ説明デフォルト値
<ID>ドキュメント ID（必須）—
--offset <N>開始行番号（1 から開始）1
--limit <N>読み取り行数（最大 500）200