docs: refresh README setup guidance

2026-05-14 16:28:52 -05:00
parent f8a4dee173
commit 2a4022acbe
6 changed files with 219 additions and 129 deletions
@@ -19,13 +19,36 @@ npm install -g deepseek-tui
 cargo install deepseek-tui-cli --locked   # `deepseek` (エントリーポイント)
 cargo install deepseek-tui     --locked   # `deepseek-tui` (TUI バイナリ)

-# 3. 直接ダウンロード — Node もツールチェーンも不要。
+# 3. Homebrew — macOS パッケージマネージャ。
+brew tap Hmbown/deepseek-tui
+brew install deepseek-tui
+
+# 4. 直接ダウンロード — Node もツールチェーンも不要。
 #    https://github.com/Hmbown/DeepSeek-TUI/releases
 #    Linux x64/ARM64、macOS x64/ARM64、Windows x64 向けのビルド済みバイナリがあります。
+
+# 5. Docker — ビルド済みリリースイメージ。
+docker volume create deepseek-tui-home
+docker run --rm -it \
+  -e DEEPSEEK_API_KEY="$DEEPSEEK_API_KEY" \
+  -v deepseek-tui-home:/home/deepseek/.deepseek \
+  -v "$PWD:/workspace" \
+  -w /workspace \
+  ghcr.io/hmbown/deepseek-tui:latest
 ```

 > 中国本土では、`--registry=https://registry.npmmirror.com` を指定して npm 経由のダウンロードを高速化するか、下記の[Cargo ミラー](#中国--ミラーフレンドリーなインストール)を利用してください。

+既にインストール済みの場合は、インストール方法に合わせて更新してください:
+
+```bash
+deepseek update
+npm install -g deepseek-tui@latest
+brew update && brew upgrade deepseek-tui
+cargo install deepseek-tui-cli --locked --force
+cargo install deepseek-tui     --locked --force
+```
+
 [![CI](https://github.com/Hmbown/DeepSeek-TUI/actions/workflows/ci.yml/badge.svg)](https://github.com/Hmbown/DeepSeek-TUI/actions/workflows/ci.yml)
 [![npm](https://img.shields.io/npm/v/deepseek-tui)](https://www.npmjs.com/package/deepseek-tui)
 [![crates.io](https://img.shields.io/crates/v/deepseek-tui-cli?label=crates.io)](https://crates.io/crates/deepseek-tui-cli)
@@ -45,10 +68,11 @@ DeepSeek TUI は、ターミナル内で完結するコーディングエージ

 ### 主な機能

- **ネイティブ RLM** (`rlm_query`) — 1〜16 個の安価な `deepseek-v4-flash` 子プロセスを並列に起動し、既存の API クライアントに対してバッチ解析と並列推論を実行
+- **Auto モード** — `--model auto` / `/model auto` がターンごとにモデルと推論強度を選択
+- **ネイティブ RLM** (`rlm_open`/`rlm_eval`) — 永続 REPL セッションでバッチ解析を行い、`peek`、`search`、`chunk`、`sub_query_batch` などの補助関数で低コストな `deepseek-v4-flash` 子タスクを実行
 - **Thinking-mode ストリーミング** — モデルがタスクに取り組む様子をリアルタイムで観察し、思考連鎖の展開を追える
 - **完全なツールスイート** — ファイル操作、シェル実行、Git、Web 検索／ブラウズ、apply-patch、サブエージェント、MCP サーバー
- **100 万トークンコンテキスト** — コンテキストが満杯になると自動でインテリジェントにコンパクション。プレフィックスキャッシュを意識したコスト効率
+- **100 万トークンコンテキスト** — コンテキスト追跡、手動または設定ベースのコンパクション、プレフィックスキャッシュのテレメトリ
 - **3 つのモード** — Plan（読み取り専用の探索）、Agent（承認ありのインタラクティブ）、YOLO（自動承認）
 - **推論努力ティア** — `Shift + Tab` で `off → high → max` を切り替え
 - **セッション保存／再開** — 長時間実行のセッションをチェックポイント化して再開可能
@@ -60,7 +84,7 @@ DeepSeek TUI は、ターミナル内で完結するコーディングエージ
 - **ユーザーメモリ** — クロスセッションの嗜好をシステムプロンプトに注入できる、オプションの永続メモファイル
 - **ローカライズ済み UI** — `en`、`ja`、`zh-Hans`、`pt-BR` を自動検出
 - **ライブコスト追跡** — ターンごと／セッションごとのトークン使用量とコスト見積もり、キャッシュヒット／ミスの内訳
- **スキルシステム** — GitHub から取得できる、合成・インストール可能な命令パック。バックエンドサービス不要
+- **スキルシステム** — GitHub から取得できる命令パック。初回起動時に `skill-creator`、`mcp-builder`、`documents`、`presentations`、`spreadsheets`、`pdf`、`feishu` などのスターターセットを同梱

 ---

@@ -77,7 +101,7 @@ DeepSeek TUI は、ターミナル内で完結するコーディングエージ
 ```bash
 npm install -g deepseek-tui
 deepseek --version
-deepseek
+deepseek --model auto
 ```

 ビルド済みバイナリは **Linux x64**、**Linux ARM64**（v0.8.8 以降）、**macOS x64**、**macOS ARM64**、**Windows x64** 向けに公開されています。その他のターゲット（musl、riscv64、FreeBSD など）は [ソースからのインストール](#install-from-source) または [docs/INSTALL.md](docs/INSTALL.md) を参照してください。
@@ -146,7 +170,7 @@ scoop install deepseek-tui
 git clone https://github.com/Hmbown/DeepSeek-TUI.git
 cd DeepSeek-TUI

-cargo install --path crates/cli --locked   # Rust 1.85+ が必要。`deepseek` を提供
+cargo install --path crates/cli --locked   # Rust 1.88+ が必要。`deepseek` を提供
 cargo install --path crates/tui --locked   # `deepseek-tui` を提供
 ```

@@ -161,34 +185,44 @@ cargo install --path crates/tui --locked   # `deepseek-tui` を提供
 deepseek auth set --provider nvidia-nim --api-key "YOUR_NVIDIA_API_KEY"
 deepseek --provider nvidia-nim

+# AtlasCloud
+deepseek auth set --provider atlascloud --api-key "YOUR_ATLASCLOUD_API_KEY"
+deepseek --provider atlascloud
+
+# OpenRouter
+deepseek auth set --provider openrouter --api-key "YOUR_OPENROUTER_API_KEY"
+deepseek --provider openrouter --model deepseek/deepseek-v4-pro
+
+# Novita
+deepseek auth set --provider novita --api-key "YOUR_NOVITA_API_KEY"
+deepseek --provider novita --model deepseek/deepseek-v4-pro
+
 # Fireworks
 deepseek auth set --provider fireworks --api-key "YOUR_FIREWORKS_API_KEY"
 deepseek --provider fireworks --model deepseek-v4-pro

+# 汎用 OpenAI 互換エンドポイント
+deepseek auth set --provider openai --api-key "YOUR_OPENAI_COMPATIBLE_API_KEY"
+OPENAI_BASE_URL="https://openai-compatible.example/v4" deepseek --provider openai --model glm-5
+
 # セルフホスト SGLang
 SGLANG_BASE_URL="http://localhost:30000/v1" deepseek --provider sglang --model deepseek-v4-flash
+
+# セルフホスト vLLM
+VLLM_BASE_URL="http://localhost:8000/v1" deepseek --provider vllm --model deepseek-v4-flash
+
+# セルフホスト Ollama
+ollama pull deepseek-coder:1.3b
+deepseek --provider ollama --model deepseek-coder:1.3b
 ```

+TUI 内では `/provider` でプロバイダーピッカー、`/model` でモデルピッカーを開けます。`/provider openrouter` や `/model <id>` で直接切り替え、`/models` で API から返るライブモデル一覧を確認できます。`/model` ピッカーは、利用可能な場合は現在のプロバイダーのライブモデルカタログを使い、ない場合はプロバイダー別の既定モデルにフォールバックします。
+
 ---

-## v0.8.12 の新機能
+## リリースノート

-v0.8.11 のキャッシュ最適化基盤の上に、コミュニティから 20 件の PR を加えた機能リリースです。[完全な変更履歴](CHANGELOG.md)。
-
- **推論努力の自動モード** — `reasoning_effort = "auto"` がプロンプトから適切なティアを選択。debug/error → Max、search/lookup → Low、デフォルト → High
- **Bash arity 辞書** — `auto_allow = ["git status"]` は `git status -s` にマッチし、`git push` にはマッチしない。git、cargo、npm、docker、kubectl ほかを認識
- **Vim モーダル編集** — 標準的な Vim キーバインディングによる normal/insert モードをコンポーザーで利用可能
- **スキルレジストリ同期** — `/skills sync` でコミュニティレジストリを取得・インストール／更新
- **FIM 編集ツール** — DeepSeek の `/beta` fill-in-the-middle エンドポイントによる外科的なコード編集
- **大型ツール出力のルーティング** — 巨大なツール結果は切り詰められたプレビューとスピルオーバーになり、親コンテキストを保護
- **プラガブルなサンドボックスバックエンド** — `exec_shell` を Alibaba OpenSandbox やその他のリモートバックエンドへルーティング可能
- **階層化された権限ルールセット** — execpolicy の deny/allow ルールに builtin/agent/user の優先度レイヤーを導入
- **キャッシュ対応の常駐サブエージェント** — V4 のプレフィックスキャッシュ局所性のためにファイル内容を先頭付加。グローバルなリーステーブル
- **統一されたスラッシュコマンド名前空間** — `$1`/`$2`/`$ARGUMENTS` テンプレートに対応したユーザーコマンド
- **Color::Reset への移行** — ハードコードされた背景色をすべて `Color::Reset` に置き換え、ライトターミナルに対応
- **新しいドキュメント**: SECURITY.md (#648)、CODE_OF_CONDUCT.md (#686)、zh-Hans ロケールの有効化 (#652)
-
-*[@merchloubna70-dot](https://github.com/merchloubna70-dot) によるコミュニティ PR 28 件。初回コントリビューターは [@zichen0116](https://github.com/zichen0116) (#686)。*
+バージョンごとの変更点は [CHANGELOG.md](CHANGELOG.md) にまとめています。この README は、現在のインストール方法、主要ワークフロー、プロバイダー設定、ランタイムインターフェース、拡張ポイントに絞っています。

 ---

@@ -197,7 +231,10 @@ v0.8.11 のキャッシュ最適化基盤の上に、コミュニティから 20
 ```bash
 deepseek                                         # インタラクティブ TUI
 deepseek "explain this function"                 # ワンショットプロンプト
+deepseek exec --auto --output-format stream-json "fix this bug"  # NDJSON バックエンドストリーム
+deepseek exec --resume <SESSION_ID> "follow up"  # 非対話セッションを継続
 deepseek --model deepseek-v4-flash "summarize"   # モデルの上書き
+deepseek --model auto "fix this bug"             # モデルと推論強度を自動選択
 deepseek --yolo                                  # ツールを自動承認
 deepseek auth set --provider deepseek            # API キーの保存
 deepseek doctor                                  # セットアップと接続性のチェック
@@ -210,10 +247,12 @@ deepseek resume --last                           # 最新セッションを再
 deepseek resume <SESSION_ID>                     # UUID 指定で特定セッションを再開
 deepseek fork <SESSION_ID>                       # 任意のターンでセッションを fork
 deepseek serve --http                            # HTTP/SSE API サーバー
-deepseek pr <N>                                  # PR を取得しレビュープロンプトに先行投入
+deepseek serve --acp                             # Zed/カスタムエージェント向け ACP stdio アダプター
+deepseek run pr <N>                              # PR を取得しレビュープロンプトに先行投入
 deepseek mcp list                                # 設定された MCP サーバー一覧
 deepseek mcp validate                            # MCP の設定／接続性を検証
 deepseek mcp-server                              # ディスパッチャー MCP stdio サーバーを実行
+deepseek update                                  # バイナリ更新の確認と適用
 ```

 ### キーボードショートカット
@@ -256,12 +295,25 @@ deepseek mcp-server                              # ディスパッチャー MCP
 |---|---|
 | `DEEPSEEK_API_KEY` | API キー |
 | `DEEPSEEK_BASE_URL` | API ベース URL |
+| `DEEPSEEK_HTTP_HEADERS` | 任意のモデルリクエストヘッダー |
 | `DEEPSEEK_MODEL` | デフォルトモデル |
-| `DEEPSEEK_PROVIDER` | `deepseek`（デフォルト）、`nvidia-nim`、`fireworks`、`sglang` |
+| `DEEPSEEK_STREAM_IDLE_TIMEOUT_SECS` | ストリームのアイドルタイムアウト秒数 |
+| `DEEPSEEK_PROVIDER` | `deepseek`（デフォルト）、`nvidia-nim`、`openai`、`atlascloud`、`openrouter`、`novita`、`fireworks`、`sglang`、`vllm`、`ollama` |
 | `DEEPSEEK_PROFILE` | 設定プロファイル名 |
 | `DEEPSEEK_MEMORY` | `on` に設定するとユーザーメモリを有効化 |
-| `NVIDIA_API_KEY` / `FIREWORKS_API_KEY` / `SGLANG_API_KEY` | プロバイダー認証 |
+| `DEEPSEEK_ALLOW_INSECURE_HTTP=1` | 信頼できるネットワークで非ローカル `http://` API ベース URL を許可 |
+| `NVIDIA_API_KEY` / `OPENAI_API_KEY` / `ATLASCLOUD_API_KEY` / `OPENROUTER_API_KEY` / `NOVITA_API_KEY` / `FIREWORKS_API_KEY` / `SGLANG_API_KEY` / `VLLM_API_KEY` / `OLLAMA_API_KEY` | プロバイダー認証 |
+| `OPENAI_BASE_URL` / `OPENAI_MODEL` | 汎用 OpenAI 互換エンドポイントとモデル ID |
+| `ATLASCLOUD_BASE_URL` / `ATLASCLOUD_MODEL` | AtlasCloud エンドポイントとモデル上書き |
+| `OPENROUTER_BASE_URL` | OpenRouter エンドポイント上書き |
+| `NOVITA_BASE_URL` | Novita エンドポイント上書き |
+| `FIREWORKS_BASE_URL` | Fireworks エンドポイント上書き |
 | `SGLANG_BASE_URL` | セルフホスト SGLang のエンドポイント |
+| `SGLANG_MODEL` | セルフホスト SGLang のモデル ID |
+| `VLLM_BASE_URL` | セルフホスト vLLM のエンドポイント |
+| `VLLM_MODEL` | セルフホスト vLLM のモデル ID |
+| `OLLAMA_BASE_URL` | セルフホスト Ollama のエンドポイント |
+| `OLLAMA_MODEL` | セルフホスト Ollama のモデルタグ |
 | `NO_ANIMATIONS=1` | 起動時にアクセシビリティモードを強制 |
 | `SSL_CERT_FILE` | 企業プロキシ向けのカスタム CA バンドル |

@@ -317,6 +369,10 @@ description: DeepSeek にカスタムワークフローを実行させたいと
 | [MCP.md](docs/MCP.md) | Model Context Protocol 統合 |
 | [RUNTIME_API.md](docs/RUNTIME_API.md) | HTTP/SSE API サーバー |
 | [INSTALL.md](docs/INSTALL.md) | プラットフォーム別インストールガイド |
+| [DOCKER.md](docs/DOCKER.md) | GHCR イメージ、ボリューム、Docker 利用方法 |
+| [CNB_MIRROR.md](docs/CNB_MIRROR.md) | CNB ミラーと中国向けインストールメモ |
+| [TENCENT_CLOUD_REMOTE_FIRST.md](docs/TENCENT_CLOUD_REMOTE_FIRST.md) | Tencent/CNB/Lighthouse/Feishu のリモート優先パス |
+| [TENCENT_LIGHTHOUSE_HK.md](docs/TENCENT_LIGHTHOUSE_HK.md) | Tencent Lighthouse 香港インスタンス設定 |
 | [MEMORY.md](docs/MEMORY.md) | ユーザーメモリ機能ガイド |
 | [SUBAGENTS.md](docs/SUBAGENTS.md) | サブエージェントの役割分類とライフサイクル |
 | [KEYBINDINGS.md](docs/KEYBINDINGS.md) | ショートカット完全カタログ |