blob: 82a8852ea548e660d4abff1aff29ababab1df39f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
|
---
title: CLI
description: OpenCode CLI のオプションとコマンド。
---
import { Tabs, TabItem } from "@astrojs/starlight/components"
OpenCode CLI は、引数なしで実行すると、デフォルトで [TUI](/docs/tui) を開始します。
```bash
opencode
```
ただし、このページに記載されているようにコマンドも受け入れます。これにより、OpenCode をプログラム的に操作できるようになります。
```bash
opencode run "Explain how closures work in JavaScript"
```
---
### tui
OpenCode ターミナルユーザーインターフェイスを開始します。
```bash
opencode [project]
```
#### フラグ
| フラグ | ショート | 説明 |
| ------------ | ----------- | ---------------------------------------------------------- |
| `--continue` | `-c` | 最後のセッションを続行 |
| `--session` | | 続行時にセッションをフォーク (`-s` または `--fork` と併用) |
| `--continue` | `--session` | 続行するセッション ID |
| `--prompt` | | 使用のプロンプト |
| `--model` | `-m` | プロバイダー/モデルの形式で使用するモデル |
| `--agent` | | 使用するエージェント |
| `--port` | | リッスンするポート |
| `--hostname` | | リッスンするホスト名 |
---
## コマンド
OpenCode CLI には次のコマンドもあります。
---
### agent
OpenCode のエージェントを管理します。
```bash
opencode agent [command]
```
---
### attach
`serve` または `web` コマンドを使用して起動された、すでに実行中の OpenCode バックエンドサーバーにターミナルを接続します。
```bash
opencode attach [url]
```
これにより、リモート OpenCode バックエンドで TUI を使用できるようになります。例えば：
```bash
# Start the backend server for web/mobile access
opencode web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backend
opencode attach http://10.20.30.40:4096
```
#### フラグ
| フラグ | ショート | 説明 |
| ----------- | -------- | ------------------------------ |
| `--dir` | | TUI を開始する作業ディレクトリ |
| `--session` | `-s` | 続行するセッション ID |
---
#### create
カスタム構成で新しいエージェントを作成します。
```bash
opencode agent create
```
このコマンドは、カスタムシステムプロンプトとツール構成を使用して新しいエージェントを作成する手順を示します。
---
#### list
利用可能なエージェントをすべてリストします。
```bash
opencode agent list
```
---
### auth
プロバイダーの資格情報とログインを管理するコマンド。
```bash
opencode auth [command]
```
---
#### login
OpenCode は [Models.dev](https://models.dev) のプロバイダーリストを利用しているため、`opencode auth login` を使用して、使用したいプロバイダーの API キーを構成できます。これは `~/.local/share/opencode/auth.json` に保存されます。
```bash
opencode auth login
```
OpenCode が起動すると、認証情報ファイルからプロバイダーがロードされます。また、環境またはプロジェクト内の `.env` ファイルで定義されたキーがあるかどうかも確認します。
---
#### list
認証情報ファイルに保存されているすべての認証されたプロバイダーをリストします。
```bash
opencode auth list
```
またはショートバージョン。
```bash
opencode auth ls
```
---
#### logout
資格情報ファイルからプロバイダーをクリアすることで、プロバイダーからログアウトします。
```bash
opencode auth logout
```
---
### github
リポジトリ自動化のための GitHub エージェントを管理します。
```bash
opencode github [command]
```
---
#### install
GitHub エージェントをリポジトリにインストールします。
```bash
opencode github install
```
これにより、必要な GitHub Actions ワークフローが設定され、構成プロセスがガイドされます。 [詳細はこちら](/docs/github)。
---
#### run
GitHub エージェントを実行します。これは通常、GitHub Actions で使用されます。
```bash
opencode github run
```
##### フラグ
| フラグ | 説明 |
| --------- | --------------------------------------------------- |
| `--event` | エージェントを実行するための GitHub モック イベント |
| `--token` | GitHub 個人アクセストークン |
---
### mcp
モデルコンテキストプロトコルサーバーを管理します。
```bash
opencode mcp [command]
```
---
#### add
MCP サーバーを構成に追加します。
```bash
opencode mcp add
```
このコマンドは、ローカルまたはリモートの MCP サーバーを追加する手順を示します。
---
#### list
構成されているすべての MCP サーバーとその接続ステータスをリストします。
```bash
opencode mcp list
```
または、短いバージョンを使用してください。
```bash
opencode mcp ls
```
---
#### auth
OAuth 対応の MCP サーバーで認証します。
```bash
opencode mcp auth [name]
```
サーバー名を指定しない場合は、利用可能な OAuth 対応サーバーから選択するように求められます。
OAuth 対応サーバーとその認証ステータスを一覧表示することもできます。
```bash
opencode mcp auth list
```
または、短いバージョンを使用してください。
```bash
opencode mcp auth ls
```
---
#### logout
MCP サーバーの OAuth 資格情報を削除します。
```bash
opencode mcp logout [name]
```
---
#### debug
MCP サーバーの OAuth 接続の問題をデバッグします。
```bash
opencode mcp debug <name>
```
---
### models
構成されたプロバイダーから利用可能なすべてのモデルをリストします。
```bash
opencode models [provider]
```
このコマンドは、構成されたプロバイダー全体で利用可能なすべてのモデルを `provider/model` の形式で表示します。
これは、[設定](/docs/config/) で使用する正確なモデル名を把握するのに役立ちます。
オプションでプロバイダー ID を渡して、そのプロバイダーによってモデルをフィルターできます。
```bash
opencode models anthropic
```
#### フラグ
| フラグ | 説明 |
| ----------- | --------------------------------------------------------------- |
| `--refresh` | models.dev からモデルキャッシュを更新します。 |
| `--verbose` | より詳細なモデル出力を使用します (コストなどのメタデータを含む) |
`--refresh` フラグを使用して、キャッシュされたモデルリストを更新します。これは、新しいモデルがプロバイダーに追加され、それを OpenCode で確認したい場合に便利です。
```bash
opencode models --refresh
```
---
### run
プロンプトを直接渡して、非対話モードで opencode を実行します。
```bash
opencode run [message..]
```
これは、スクリプト作成、自動化、または完全な TUI を起動せずに迅速な回答が必要な場合に便利です。例えば。
```bash "opencode run"
opencode run Explain the use of context in Go
```
実行中の `opencode serve` インスタンスにアタッチして、実行ごとの MCP サーバーのコールドブート時間を回避することもできます。
```bash
# Start a headless server in one terminal
opencode serve
# In another terminal, run commands that attach to it
opencode run --attach http://localhost:4096 "Explain async/await in JavaScript"
```
#### フラグ
| フラグ | ショート | 説明 |
| ------------ | -------- | ----------------------------------------------------------------------------------------- |
| `--command` | | 実行するコマンド。引数には message を使用します。 |
| `--continue` | `-c` | 最後のセッションを続行 |
| `--session` | `-s` | 続行するセッション ID |
| `--fork` | | 続行時にセッションをフォーク (`--continue` または `--session` と併用) |
| `--share` | | セッションを共有する |
| `--model` | `-m` | プロバイダー/モデルの形式で使用するモデル |
| `--agent` | | 使用するエージェント |
| `--file` | `-f` | メッセージに添付するファイル |
| `--format` | | 形式: デフォルト (フォーマット済み) または json (生の JSON イベント) |
| `--title` | | セッションのタイトル (値が指定されていない場合は、切り詰められたプロンプトが使用されます) |
| `--attach` | | 実行中の opencode サーバー (http://localhost:4096 など) に接続します。 |
| `--port` | | ローカルサーバーのポート (デフォルトはランダムポート) |
---
### serve
API アクセスのためにヘッドレス OpenCode サーバーを起動します。完全な HTTP インターフェイスについては、[サーバーのドキュメント](/docs/server) を確認してください。
```bash
opencode serve
```
これにより、TUI インターフェイスを使用せずに opencode 機能への API アクセスを提供する HTTP サーバーが起動します。 `OPENCODE_SERVER_PASSWORD` を設定して HTTP 基本認証を有効にします (ユーザー名のデフォルトは `opencode`)。
#### フラグ
| フラグ | 説明 |
| ------------ | --------------------------------------- |
| `--port` | リッスンするポート |
| `--hostname` | リッスンするホスト名 |
| `--mdns` | mDNS 検出を有効にする |
| `--cors` | CORS を許可する追加のブラウザーオリジン |
---
### session
OpenCode セッションを管理します。
```bash
opencode session [command]
```
---
#### list
すべての OpenCode セッションをリストします。
```bash
opencode session list
```
##### フラグ
| フラグ | ショート | 説明 |
| ------------- | -------- | ---------------------------------------- |
| `--max-count` | `-n` | 最新のセッションを N 個に制限 |
| `--format` | | 出力形式: テーブルまたは json (テーブル) |
---
### stats
OpenCode セッションのトークンの使用状況とコストの統計を表示します。
```bash
opencode stats
```
#### フラグ
| フラグ | 説明 |
| ----------- | ------------------------------------------------------------------------------------------ |
| `--days` | 過去 N 日間の統計を表示 (全期間) |
| `--tools` | 表示するツールの数 (すべて) |
| `--models` | モデルの使用状況の内訳を表示 (デフォルトでは非表示)。上位 N 件を表示するには数値を渡します |
| `--project` | プロジェクトでフィルタリング (全プロジェクト、空文字列: 現在のプロジェクト) |
---
### export
セッションデータを JSON としてエクスポートします。
```bash
opencode export [sessionID]
```
セッション ID を指定しない場合は、利用可能なセッションから選択するように求められます。
---
### import
JSON ファイルまたは OpenCode 共有 URL からセッションデータをインポートします。
```bash
opencode import <file>
```
ローカルファイルまたは OpenCode 共有 URL からインポートできます。
```bash
opencode import session.json
opencode import https://opncd.ai/s/abc123
```
---
### web
Web インターフェイスを使用してヘッドレス OpenCode サーバーを起動します。
```bash
opencode web
```
これにより、HTTP サーバーが起動し、Web ブラウザが開き、Web インターフェイスを通じて OpenCode にアクセスします。 `OPENCODE_SERVER_PASSWORD` を設定して HTTP 基本認証を有効にします (ユーザー名のデフォルトは `opencode`)。
#### フラグ
| フラグ | 説明 |
| ------------ | --------------------------------------- |
| `--port` | リッスンするポート |
| `--hostname` | リッスンするホスト名 |
| `--mdns` | mDNS 検出を有効にする |
| `--cors` | CORS を許可する追加のブラウザーオリジン |
---
### acp
ACP (エージェントクライアントプロトコル) サーバーを起動します。
```bash
opencode acp
```
このコマンドは、nd-JSON を使用して stdin/stdout 経由で通信する ACP サーバーを起動します。
#### フラグ
| フラグ | 説明 |
| ------------ | -------------------- |
| `--cwd` | 作業ディレクトリ |
| `--port` | リッスンするポート |
| `--hostname` | リッスンするホスト名 |
---
### uninstall
OpenCode をアンインストールし、関連ファイルをすべて削除します。
```bash
opencode uninstall
```
#### フラグ
| フラグ | ショート | 説明 |
| --------------- | -------- | -------------------------------------------- |
| `--keep-config` | `-c` | 構成ファイルを保持する |
| `--keep-data` | `-d` | セッションデータとスナップショットを保持する |
| `--dry-run` | | 削除せずに削除される内容を表示する |
| `--force` | `-f` | 確認プロンプトをスキップする |
---
### upgrade
opencode を最新バージョンまたは特定のバージョンに更新します。
```bash
opencode upgrade [target]
```
最新バージョンにアップグレードするには。
```bash
opencode upgrade
```
特定のバージョンにアップグレードするには。
```bash
opencode upgrade v0.1.48
```
#### フラグ
| フラグ | ショート | 説明 |
| ---------- | -------- | ------------------------------------------------------ |
| `--method` | `-m` | 使用されたインストール方法。curl, npm, pnpm, bun, brew |
---
## グローバルフラグ
opencode CLI は次のグローバルフラグを受け取ります。
| フラグ | ショート | 説明 |
| -------------- | -------- | ------------------------------------- |
| `--help` | `-h` | ヘルプを表示 |
| `--version` | `-v` | バージョン番号を出力 |
| `--print-logs` | | ログを標準エラー出力に出力 |
| `--log-level` | | ログレベル (DEBUG、INFO、WARN、ERROR) |
---
## 環境変数
OpenCode は環境変数を使用して構成できます。
| 変数 | タイプ | 説明 |
| ------------------------------------- | -------- | ------------------------------------------------------------------- |
| `OPENCODE_AUTO_SHARE` | ブール値 | セッションを自動的に共有する |
| `OPENCODE_GIT_BASH_PATH` | 文字列 | Windows 上で実行可能な Git Bash へのパス |
| `OPENCODE_CONFIG` | 文字列 | 構成ファイルへのパス |
| `OPENCODE_CONFIG_DIR` | 文字列 | config ディレクトリへのパス |
| `OPENCODE_CONFIG_CONTENT` | 文字列 | インライン JSON 構成コンテンツ |
| `OPENCODE_DISABLE_AUTOUPDATE` | ブール値 | 自動更新チェックを無効にする |
| `OPENCODE_DISABLE_PRUNE` | ブール値 | 古いデータのプルーニングを無効にする |
| `OPENCODE_DISABLE_TERMINAL_TITLE` | ブール値 | ターミナルタイトルの自動更新を無効にする |
| `OPENCODE_PERMISSION` | 文字列 | インライン化された json 権限設定 |
| `OPENCODE_DISABLE_DEFAULT_PLUGINS` | ブール値 | デフォルトのプラグインを無効にする |
| `OPENCODE_DISABLE_LSP_DOWNLOAD` | ブール値 | LSP サーバーの自動ダウンロードを無効にする |
| `OPENCODE_ENABLE_EXPERIMENTAL_MODELS` | ブール値 | 実験モデルを有効にする |
| `OPENCODE_DISABLE_AUTOCOMPACT` | ブール値 | 自動コンテキスト圧縮を無効にする |
| `OPENCODE_DISABLE_CLAUDE_CODE` | ブール値 | `.claude` からの読み取りを無効にする (プロンプト + スキル) |
| `OPENCODE_DISABLE_CLAUDE_CODE_PROMPT` | ブール値 | `~/.claude/CLAUDE.md` の読み取りを無効にする |
| `OPENCODE_DISABLE_CLAUDE_CODE_SKILLS` | ブール値 | `.claude/skills` のロードを無効にする |
| `OPENCODE_DISABLE_MODELS_FETCH` | ブール値 | リモートソースからのモデルの取得を無効にする |
| `OPENCODE_FAKE_VCS` | 文字列 | テスト目的の偽の VCS プロバイダー |
| `OPENCODE_CLIENT` | 文字列 | クライアント識別子 (デフォルトは `cli`) |
| `OPENCODE_ENABLE_EXA` | ブール値 | Exa Web 検索ツールを有効にする |
| `OPENCODE_SERVER_PASSWORD` | 文字列 | `serve`/`web` の基本認証を有効にする |
| `OPENCODE_SERVER_USERNAME` | 文字列 | 基本認証ユーザー名 (デフォルト `opencode`) をオーバーライドします。 |
| `OPENCODE_MODELS_URL` | 文字列 | モデル設定を取得するためのカスタム URL |
---
### 実験的
これらの環境変数により、変更または削除される可能性のある実験的な機能が有効になります。
| 変数 | タイプ | 説明 |
| ----------------------------------------------- | -------- | ------------------------------------------------ |
| `OPENCODE_EXPERIMENTAL` | ブール値 | すべての実験的機能を有効にする |
| `OPENCODE_EXPERIMENTAL_ICON_DISCOVERY` | ブール値 | アイコン検出を有効にする |
| `OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT` | ブール値 | TUI で選択時のコピーを無効にする |
| `OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS` | 数値 | bash コマンドのデフォルトのタイムアウト (ミリ秒) |
| `OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX` | 数値 | LLM 応答の最大出力トークン |
| `OPENCODE_EXPERIMENTAL_FILEWATCHER` | ブール値 | ディレクトリ全体のファイル監視を有効にする |
| `OPENCODE_EXPERIMENTAL_OXFMT` | ブール値 | oxfmt フォーマッタを有効にする |
| `OPENCODE_EXPERIMENTAL_LSP_TOOL` | ブール値 | 実験的な LSP ツールを有効にする |
| `OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHER` | ブール値 | ファイルウォッチャーを無効にする |
| `OPENCODE_EXPERIMENTAL_EXA` | ブール値 | 実験的な Exa 機能を有効にする |
| `OPENCODE_EXPERIMENTAL_LSP_TY` | ブール値 | python ファイルの TY LSP を有効にする |
| `OPENCODE_EXPERIMENTAL_MARKDOWN` | ブール値 | 試験的な Markdown 機能を有効にする |
| `OPENCODE_EXPERIMENTAL_PLAN_MODE` | ブール値 | プランモードを有効にする |
|
