Skip to content

Commit dcd3913

Browse files
eltocieareltociear
committed
docs: add Japanese README
1 parent ed2aa23 commit dcd3913

3 files changed

Lines changed: 211 additions & 2 deletions

File tree

‎README-en.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
[![][npm-release-shield]][npm-release-link] [![][npm-downloads-shield]][npm-downloads-link] [![][github-contributors-shield]][github-contributors-link] [![][github-forks-shield]][github-forks-link] [![][github-stars-shield]][github-stars-link]
1212
[![][github-issues-shield]][github-issues-link] [![][github-issues-pr-shield]][github-issues-pr-link] [![][github-license-shield]][github-license-link]
1313

14-
English · [中文](./README.md)
14+
English · [中文](./README.md) · [日本語](./README-ja_JP.md)
1515

1616
<br/>
1717
</div>

‎README-ja_JP.md‎

Lines changed: 209 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,209 @@
1+
<div align="center">
2+
<br/>
3+
<br/>
4+
<p align="center">
5+
<a href='https://deepcode.vegamo.cn/'>
6+
<img src='https://avatars.githubusercontent.com/u/118287711?s=200&v=4' width='100' alt="deepcode-cli"/>
7+
</a>
8+
</p>
9+
<h1>Deep Code CLI</h1>
10+
11+
[![][npm-release-shield]][npm-release-link] [![][npm-downloads-shield]][npm-downloads-link] [![][github-contributors-shield]][github-contributors-link] [![][github-forks-shield]][github-forks-link] [![][github-stars-shield]][github-stars-link]
12+
[![][github-issues-shield]][github-issues-link] [![][github-issues-pr-shield]][github-issues-pr-link] [![][github-license-shield]][github-license-link]
13+
14+
[English](./README-en.md) · [中文](./README.md) · 日本語
15+
16+
<br/>
17+
</div>
18+
19+
[Deep Code](https://github.com/lessweb/deepcode-cli) は、`deepseek-v4` モデルに最適化されたターミナル AI コーディングアシスタントです。深い思考(Deep Thinking)、推論努力(Reasoning Effort)の制御、Agent Skills、MCP(Model Context Protocol)統合をサポートしています。
20+
21+
22+
## インストール
23+
24+
```bash
25+
npm install -g @vegamo/deepcode-cli
26+
```
27+
28+
任意のプロジェクトディレクトリで `deepcode` を実行して開始します。
29+
30+
![intro2](resources/intro2.png)
31+
32+
## 設定
33+
34+
`~/.deepcode/settings.json` を作成します:
35+
36+
```json
37+
{
38+
"env": {
39+
"MODEL": "deepseek-v4-pro",
40+
"BASE_URL": "https://api.deepseek.com",
41+
"API_KEY": "sk-..."
42+
},
43+
"thinkingEnabled": true,
44+
"reasoningEffort": "max"
45+
}
46+
```
47+
48+
この設定ファイルは [Deep Code VSCode 拡張機能](https://github.com/lessweb/deepcode) と共有されます — 一度設定すれば、どこでも使えます。
49+
50+
設定の詳細(多階層の優先順位、環境変数など)については、[docs/configuration.md](docs/configuration.md) を参照してください。
51+
52+
## 主な機能
53+
54+
### **スキル(Skills)**
55+
Deep Code CLI はエージェントスキルをサポートしており、アシスタントの機能を拡張できます:
56+
57+
スキルは以下の場所から、優先順位の高い順に検出されます:
58+
59+
| スコープ | パス | 用途 |
60+
| :--------- | :-------------------- | :---------------------------- |
61+
| プロジェクト | `./.deepcode/skills/` | Deep Code のネイティブな場所 |
62+
| プロジェクト | `./.agents/skills/` | クロスクライアント相互運用性 |
63+
| ユーザー | `~/.deepcode/skills/` | Deep Code のネイティブな場所 |
64+
| ユーザー | `~/.agents/skills/` | クロスクライアント相互運用性 |
65+
66+
### **DeepSeek に最適化**
67+
- DeepSeek モデルのパフォーマンスに特化してチューニングされています。
68+
- [Context Caching](https://api-docs.deepseek.com/guides/kv_cache) を利用してコストを削減できます。
69+
- [Thinking Mode](https://api-docs.deepseek.com/guides/thinking_mode) と Effort Control をネイティブにサポートしています。
70+
71+
## スラッシュコマンドとキーボードショートカット
72+
73+
| スラッシュコマンド | 動作 |
74+
|------------------|------------------------------------------------------------|
75+
| `/` | スキル / コマンドメニューを開く |
76+
| `/new` | 新しい会話を開始する |
77+
| `/resume` | 続きから再開する以前の会話を選択する |
78+
| `/continue` | アクティブな会話を続けるか、再開する会話を選択する |
79+
| `/model` | モデル、思考モード、推論努力を切り替える |
80+
| `/raw` | 表示モードを切り替える(Normal / Lite / Raw スクロールバック) |
81+
| `/init` | AGENTS.md ファイルを初期化する(LLM プロジェクト指示) |
82+
| `/skills` | 利用可能なスキルを一覧表示する |
83+
| `/mcp` | MCP サーバーの状態と利用可能なツールを表示する |
84+
| `/undo` | コードや会話を以前の状態に復元する |
85+
| `/exit` | 終了する(`Ctrl+D` を 2 回でも可) |
86+
87+
| キー | 動作 |
88+
|------------------|------------------------------------------------------------|
89+
| `Enter` | プロンプトを送信する |
90+
| `Shift+Enter` | 改行を挿入する(`Ctrl+J` でも可) |
91+
| `Ctrl+V` | クリップボードから画像を貼り付ける |
92+
| `Esc` | 現在のモデルターンを中断する |
93+
| `Ctrl+D` を 2 回 | Deep Code を終了する |
94+
95+
## サポートされているモデル
96+
97+
- `deepseek-v4-pro`(推奨)
98+
- `deepseek-v4-flash`
99+
- その他の OpenAI 互換モデル
100+
101+
## FAQ
102+
103+
### Deep Code に VSCode 拡張機能はありますか?
104+
105+
はい。Deep Code はフル機能の VSCode 拡張機能を提供しており、[VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=vegamo.deepcode-vscode) から入手できます。拡張機能は CLI と `~/.deepcode/settings.json` 設定ファイルを共有しているため、ターミナルとエディタをシームレスに切り替えられます。
106+
107+
### Deep Code は画像の理解をサポートしていますか?
108+
109+
Deep Code はマルチモーダル入力をサポートしています — `Ctrl+V` でクリップボードから画像を貼り付けられます。ただし、`deepseek-v4` はまだマルチモーダルに対応していません。一部のモデルはマルチモーダル機能を持っていますが、マルチターン対話のリクエストに厳しい制限があります。マルチモーダル入力には、最も統合が優れている Volcano Ark の `Doubao-Seed-2.0-pro` モデルの使用をおすすめします。
110+
111+
### タスク完了後に自動で Slack メッセージを送信するには?
112+
113+
Slack の Webhook を呼び出すシェル通知スクリプトを作成し、`~/.deepcode/settings.json` の `notify` フィールドにそのスクリプトのフルパスを設定します。詳細な手順は [docs/notify_en.md](docs/notify_en.md) を参照してください。
114+
115+
### Web 検索を有効にするには?
116+
117+
Deep Code には、ほとんどのユースケースで十分に機能する無料の Web Search ツールが組み込まれています。Web 検索にカスタムスクリプトを使いたい場合は、`~/.deepcode/settings.json` の `webSearchTool` フィールドにスクリプトのフルパスを設定してください。詳細な手順は次を参照してください: https://github.com/qorzj/web_search_cli
118+
119+
### Coding Plan はサポートされていますか?
120+
121+
はい。`~/.deepcode/settings.json` の `env.BASE_URL` を OpenAI 互換の API エンドポイントに設定するだけです。Volcano Ark の Coding Plan を例にすると:
122+
123+
```json
124+
{
125+
"env": {
126+
"MODEL": "ark-code-latest",
127+
"BASE_URL": "https://ark.cn-beijing.volces.com/api/coding/v3",
128+
"API_KEY": "**************"
129+
},
130+
"thinkingEnabled": true
131+
}
132+
```
133+
134+
### MCP を設定するには?
135+
136+
Deep Code は MCP(Model Context Protocol)をサポートしており、GitHub、ブラウザ、データベースなどの外部サービスに接続できます。`settings.json` の `mcpServers` フィールドを設定して有効化し、`/mcp` コマンドで MCP サーバーの状態と利用可能なツールを確認できます。
137+
138+
詳細なセットアップ手順は次を参照してください: [docs/mcp.md](docs/mcp.md)
139+
140+
### タスク完了後に通知を送信するように Deep Code を設定するには?
141+
142+
AI アシスタントがタスクを完了すると、Deep Code は通知スクリプトを自動的に実行して、タスクの結果を指定されたチャネル(Slack、システム通知など)に送信できます。
143+
144+
詳細な設定手順は次を参照してください: [docs/notify_en.md](docs/notify_en.md)
145+
146+
### Deep Code は YOLO モードのみのサポートですか?
147+
148+
いいえ。Deep Code にはきめ細かな権限制御メカニズムが組み込まれており、AI アシスタントがシェルコマンドの実行、ファイルの読み書き、ネットワークアクセスなどを行う前に操作を確認できます。`settings.json` の `permissions` フィールドで、各権限スコープのポリシー(常に許可、常に確認、拒否)を設定できます。詳細は [docs/permission.md](docs/permission.md) を参照してください。
149+
150+
## コントリビューション
151+
152+
コントリビューションを歓迎します!始め方は次のとおりです:
153+
154+
```bash
155+
# リポジトリをクローン
156+
git clone https://github.com/lessweb/deepcode-cli.git
157+
cd deepcode-cli
158+
159+
# 依存関係をインストール
160+
npm install
161+
162+
# ローカル開発(型チェック + Lint + フォーマットチェック + バンドル)
163+
npm run build
164+
165+
# テストを実行
166+
npm test
167+
168+
# グローバルにリンク(ローカルのグローバルインストール)
169+
npm link
170+
```
171+
172+
- PR を提出する前に `npm run check` が通ることを確認してください(型チェック + Lint + フォーマットチェック)
173+
- エラーを避けるため、ビルド前に `npm run format` を実行することをおすすめします
174+
175+
## ヘルプ
176+
177+
- バグ報告や機能リクエストは GitHub Issues へ (https://github.com/lessweb/deepcode-cli/issues)
178+
179+
## ライセンス
180+
181+
- MIT
182+
183+
## 応援のお願い
184+
185+
このツールが役に立ったと感じたら、次の方法で応援をご検討ください:
186+
187+
- GitHub で Star を付ける (https://github.com/lessweb/deepcode-cli)
188+
- フィードバックや提案を送る
189+
- 友人や同僚に共有する
190+
191+
192+
<!-- LINK GROUP -->
193+
194+
[npm-release-link]: https://www.npmjs.com/package/@vegamo/deepcode-cli
195+
[npm-release-shield]: https://img.shields.io/npm/v/@vegamo/deepcode-cli?color=4d6BFE&labelColor=black&logo=npm&logoColor=white&style=flat-square&cacheSeconds=1800
196+
[npm-downloads-link]: https://www.npmjs.com/package/@vegamo/deepcode-cli
197+
[npm-downloads-shield]: https://img.shields.io/npm/dt/@vegamo/deepcode-cli?labelColor=black&style=flat-square&color=4d6BFE&cacheSeconds=1800
198+
[github-contributors-link]: https://github.com/lessweb/deepcode-cli/graphs/contributors
199+
[github-contributors-shield]: https://img.shields.io/github/contributors/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square&cacheSeconds=1800
200+
[github-forks-link]: https://github.com/lessweb/deepcode-cli/network/members
201+
[github-forks-shield]: https://img.shields.io/github/forks/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square&cacheSeconds=1800
202+
[github-stars-link]: https://github.com/lessweb/deepcode-cli/network/stargazers
203+
[github-stars-shield]: https://img.shields.io/github/stars/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square&cacheSeconds=1800
204+
[github-issues-link]: https://github.com/lessweb/deepcode-cli/issues
205+
[github-issues-shield]: https://img.shields.io/github/issues/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square&cacheSeconds=1800
206+
[github-issues-pr-link]: https://github.com/lessweb/deepcode-cli/pulls
207+
[github-issues-pr-shield]: https://img.shields.io/github/issues-pr/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square&cacheSeconds=1800
208+
[github-license-link]: https://github.com/lessweb/deepcode-cli/blob/main/LICENSE
209+
[github-license-shield]: https://img.shields.io/github/license/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square&cacheSeconds=1800

‎README-zh_CN.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
[![][npm-release-shield]][npm-release-link] [![][npm-downloads-shield]][npm-downloads-link] [![][github-contributors-shield]][github-contributors-link] [![][github-forks-shield]][github-forks-link] [![][github-stars-shield]][github-stars-link]
1212
[![][github-issues-shield]][github-issues-link] [![][github-issues-pr-shield]][github-issues-pr-link] [![][github-license-shield]][github-license-link]
1313

14-
[English](README-en.md) · 中文
14+
[English](README-en.md) · 中文 · [日本語](README-ja_JP.md)
1515

1616
<br/>
1717
</div>

0 commit comments

Comments
 (0)