mirror of
https://github.com/zhayujie/chatgpt-on-wechat.git
synced 2026-06-03 19:17:10 +08:00
docs: update docs
This commit is contained in:
zhayujie
101
docs/ja/cli/general.mdx
Normal file
101
docs/ja/cli/general.mdx
Normal file
@@ -0,0 +1,101 @@
|
||||
---
|
||||
title: 汎用コマンド
|
||||
description: ステータスの確認、設定管理、コンテキスト制御などのよく使うコマンド
|
||||
---
|
||||
|
||||
以下のコマンドはチャットで `/` プレフィックス、ターミナルで `cow` プレフィックスで使用できます（一部はチャット専用）。
|
||||
|
||||
<Tip>
|
||||
Web コンソールでは `/` を入力すると自動補完メニューが表示され、キーボードのナビゲーションと Tab 補完に対応しています。
|
||||
</Tip>
|
||||
|
||||
## help
|
||||
|
||||
使用可能なすべてのコマンドのヘルプ情報を表示します。
|
||||
|
||||
```text
|
||||
/help
|
||||
```
|
||||
|
||||
## status
|
||||
|
||||
現在のセッションとサービスの実行状態を表示します。プロセス情報、モデル設定、メッセージ数、読み込み済みスキル数を含みます。
|
||||
|
||||
```text
|
||||
/status
|
||||
```
|
||||
|
||||
## config
|
||||
|
||||
実行時設定の表示または変更を行います。変更は即座に反映され、再起動は不要です。
|
||||
|
||||
**すべての設定項目を表示：**
|
||||
|
||||
```text
|
||||
/config
|
||||
```
|
||||
|
||||
**単一の設定項目を表示：**
|
||||
|
||||
```text
|
||||
/config model
|
||||
```
|
||||
|
||||
**設定項目を変更：**
|
||||
|
||||
```text
|
||||
/config model deepseek-chat
|
||||
```
|
||||
|
||||
**変更可能な設定項目：**
|
||||
|
||||
| 項目 | 説明 | 例 |
|
||||
| --- | --- | --- |
|
||||
| `model` | AI モデル名 | `deepseek-chat` |
|
||||
| `agent_max_context_tokens` | 最大コンテキストトークン数 | `40000` |
|
||||
| `agent_max_context_turns` | 最大コンテキスト記憶ターン数 | `30` |
|
||||
| `agent_max_steps` | タスクごとの最大判断ステップ数 | `15` |
|
||||
|
||||
<Note>
|
||||
`model` を変更すると、システムが対応するモデル API を自動的にマッチングします。設定は `config.json` に永続的に保存されます。
|
||||
</Note>
|
||||
|
||||
## context
|
||||
|
||||
現在のセッションのコンテキスト統計情報を表示します。メッセージ数やコンテンツの長さを含みます。
|
||||
|
||||
```text
|
||||
/context
|
||||
```
|
||||
|
||||
**現在のセッションのコンテキストをクリア：**
|
||||
|
||||
```text
|
||||
/context clear
|
||||
```
|
||||
|
||||
<Tip>
|
||||
コンテキストをクリアすると、Agent は以前の会話内容を「忘れます」。話題の切り替えやコンテキストスペースの解放に便利です。
|
||||
</Tip>
|
||||
|
||||
## logs
|
||||
|
||||
最近のサービスログを表示します。デフォルトでは最近の 20 行を表示し、最大 50 行です。
|
||||
|
||||
```text
|
||||
/logs
|
||||
```
|
||||
|
||||
**行数を指定：**
|
||||
|
||||
```text
|
||||
/logs 50
|
||||
```
|
||||
|
||||
## version
|
||||
|
||||
現在の CowAgent のバージョンを表示します。
|
||||
|
||||
```text
|
||||
/version
|
||||
```
|
||||
84
docs/ja/cli/index.mdx
Normal file
84
docs/ja/cli/index.mdx
Normal file
@@ -0,0 +1,84 @@
|
||||
---
|
||||
title: コマンド概要
|
||||
description: CowAgent コマンドシステム — ターミナル CLI とチャットコマンド
|
||||
---
|
||||
|
||||
CowAgent は2つのコマンド操作方法を提供しています：
|
||||
|
||||
- **ターミナル CLI** — システムターミナルで `cow <コマンド>` を実行し、サービス管理やスキル管理を行います
|
||||
- **チャットコマンド** — 会話で `/<コマンド>` または `cow <コマンド>` を入力し、ステータス確認、スキル管理、設定変更を行います
|
||||
|
||||
## Cow CLI
|
||||
|
||||
ワンクリックインストールスクリプトでデプロイすると、`cow` コマンドが自動的に利用可能になります。手動インストールの場合は以下を実行してください：
|
||||
|
||||
```bash
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
インストール後、任意の場所で `cow` コマンドを使用できます：
|
||||
|
||||
```bash
|
||||
cow help
|
||||
```
|
||||
|
||||
出力例：
|
||||
|
||||
```
|
||||
🐮 CowAgent CLI
|
||||
|
||||
Usage: cow <command>
|
||||
|
||||
Service:
|
||||
start Start the CowAgent service
|
||||
stop Stop the CowAgent service
|
||||
restart Restart the CowAgent service
|
||||
update Update code and restart service
|
||||
status Show service status
|
||||
logs View service logs
|
||||
|
||||
Skills:
|
||||
skill Manage skills (list / search / install / uninstall ...)
|
||||
|
||||
Others:
|
||||
help Show this help message
|
||||
version Show version
|
||||
```
|
||||
|
||||
## チャットコマンド
|
||||
|
||||
Web コンソールや接続されたチャネルの会話で `/` を入力すると、コマンドの候補が表示されます。使用可能なコマンド：
|
||||
|
||||
| コマンド | 説明 |
|
||||
| --- | --- |
|
||||
| `/help` | コマンドヘルプを表示 |
|
||||
| `/status` | サービスの状態と設定を表示 |
|
||||
| `/config` | 実行時設定の表示・変更 |
|
||||
| `/skill` | スキル管理（インストール、アンインストール、有効化、無効化など） |
|
||||
| `/context` | 現在のセッションのコンテキスト情報を表示 |
|
||||
| `/context clear` | 現在のセッションのコンテキストをクリア |
|
||||
| `/logs` | 最近のログを表示 |
|
||||
| `/version` | バージョン番号を表示 |
|
||||
|
||||
<Tip>
|
||||
`/start`、`/stop`、`/restart` などのサービス管理コマンドは、プロセス操作を伴うため、ターミナルでの使用を案内します。
|
||||
</Tip>
|
||||
|
||||
## コマンド対応表
|
||||
|
||||
| コマンド | ターミナル (`cow`) | チャット (`/`) |
|
||||
| --- | :---: | :---: |
|
||||
| help | ✓ | ✓ |
|
||||
| version | ✓ | ✓ |
|
||||
| status | ✓ | ✓ |
|
||||
| logs | ✓ | ✓ |
|
||||
| config | ✗ | ✓ |
|
||||
| context | — | ✓ |
|
||||
| skill（サブコマンド） | ✓ | ✓ |
|
||||
| start / stop / restart | ✓ | ✗ |
|
||||
| update | ✓ | ✗ |
|
||||
| install-browser | ✓ | ✗ |
|
||||
|
||||
<Note>
|
||||
`context` はターミナルではチャットでの使用を案内するのみです。`config` はチャットでのみ利用可能です。
|
||||
</Note>
|
||||
123
docs/ja/cli/process.mdx
Normal file
123
docs/ja/cli/process.mdx
Normal file
@@ -0,0 +1,123 @@
|
||||
---
|
||||
title: プロセス管理
|
||||
description: cow コマンドで CowAgent プロセスのライフサイクルを管理
|
||||
---
|
||||
|
||||
プロセス管理コマンドは CowAgent バックグラウンドプロセスのライフサイクルを制御します。これらのコマンドはターミナルでのみ使用可能です。
|
||||
|
||||
## start
|
||||
|
||||
CowAgent サービスを起動します。デフォルトではバックグラウンドデーモンとして実行され、自動的にログを表示します。
|
||||
|
||||
```bash
|
||||
cow start
|
||||
```
|
||||
|
||||
**オプション：**
|
||||
|
||||
| オプション | 説明 |
|
||||
| --- | --- |
|
||||
| `-f`, `--foreground` | フォアグラウンドで実行（デーモンとして起動しない） |
|
||||
| `--no-logs` | 起動後にログを自動表示しない |
|
||||
|
||||
## stop
|
||||
|
||||
実行中の CowAgent サービスを停止します。
|
||||
|
||||
```bash
|
||||
cow stop
|
||||
```
|
||||
|
||||
## restart
|
||||
|
||||
CowAgent サービスを再起動します（停止してから起動）。
|
||||
|
||||
```bash
|
||||
cow restart
|
||||
```
|
||||
|
||||
**オプション：**
|
||||
|
||||
| オプション | 説明 |
|
||||
| --- | --- |
|
||||
| `--no-logs` | 再起動後にログを自動表示しない |
|
||||
|
||||
## update
|
||||
|
||||
コードを更新してサービスを再起動します。自動的に以下を実行します：
|
||||
|
||||
1. 最新コードをプル（`git pull`）
|
||||
2. 現在のサービスを停止
|
||||
3. Python 依存パッケージを更新
|
||||
4. CLI を再インストール
|
||||
5. サービスを起動
|
||||
|
||||
```bash
|
||||
cow update
|
||||
```
|
||||
|
||||
<Warning>
|
||||
`git pull` が失敗した場合（ローカルの未コミットの変更がある場合など）、更新は中止され、サービスには影響しません。
|
||||
</Warning>
|
||||
|
||||
## status
|
||||
|
||||
CowAgent サービスの実行状態を確認します。プロセス情報、バージョン、現在のモデルとチャネルの設定を含みます。
|
||||
|
||||
```bash
|
||||
cow status
|
||||
```
|
||||
|
||||
## logs
|
||||
|
||||
サービスログを表示します。
|
||||
|
||||
```bash
|
||||
cow logs
|
||||
```
|
||||
|
||||
**オプション：**
|
||||
|
||||
| オプション | 説明 | デフォルト値 |
|
||||
| --- | --- | --- |
|
||||
| `-f`, `--follow` | ログ出力を継続的に追跡 | いいえ |
|
||||
| `-n`, `--lines` | 最近の N 行を表示 | 50 |
|
||||
|
||||
例：
|
||||
|
||||
```bash
|
||||
# 最近の100行を表示
|
||||
cow logs -n 100
|
||||
|
||||
# ログを継続的に追跡
|
||||
cow logs -f
|
||||
```
|
||||
|
||||
## install-browser
|
||||
|
||||
[ブラウザツール](/ja/tools/browser)のために Playwright と Chromium ブラウザをインストールします。
|
||||
|
||||
```bash
|
||||
cow install-browser
|
||||
```
|
||||
|
||||
<Tip>
|
||||
ブラウザツール（Web ブラウジング、スクリーンショットなど）を使用する場合にのみ必要です。
|
||||
</Tip>
|
||||
|
||||
## run.sh との互換性
|
||||
|
||||
Cow CLI がインストールされていない場合は、`run.sh` でサービスを管理できます：
|
||||
|
||||
| cow コマンド | run.sh 相当 |
|
||||
| --- | --- |
|
||||
| `cow start` | `./run.sh start` |
|
||||
| `cow stop` | `./run.sh stop` |
|
||||
| `cow restart` | `./run.sh restart` |
|
||||
| `cow update` | `./run.sh update` |
|
||||
| `cow status` | `./run.sh status` |
|
||||
| `cow logs` | `./run.sh logs` |
|
||||
|
||||
<Note>
|
||||
`cow` コマンドの使用を推奨します。よりシンプルな構文と豊富な機能を提供します。ワンクリックインストールスクリプトで自動的にインストールされます。
|
||||
</Note>
|
||||
192
docs/ja/cli/skill.mdx
Normal file
192
docs/ja/cli/skill.mdx
Normal file
@@ -0,0 +1,192 @@
|
||||
---
|
||||
title: スキル管理
|
||||
description: コマンドでスキルのインストール、アンインストール、有効化、無効化、管理を行う
|
||||
---
|
||||
|
||||
スキル管理コマンドは CowAgent のスキルのインストール、検索、管理に使用します。チャットでは `/skill <サブコマンド>`、ターミナルでは `cow skill <サブコマンド>` を使用します。
|
||||
|
||||
## list
|
||||
|
||||
インストール済みスキルとその状態を一覧表示します。
|
||||
|
||||
<CodeGroup>
|
||||
```text チャット
|
||||
/skill list
|
||||
```
|
||||
|
||||
```bash ターミナル
|
||||
cow skill list
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
**スキル広場を閲覧**（利用可能なすべてのスキルを表示）：
|
||||
|
||||
<CodeGroup>
|
||||
```text チャット
|
||||
/skill list --remote
|
||||
```
|
||||
|
||||
```bash ターミナル
|
||||
cow skill list --remote
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
**オプション：**
|
||||
|
||||
| オプション | 説明 | デフォルト値 |
|
||||
| --- | --- | --- |
|
||||
| `--remote`, `-r` | Skill Hub のリモートスキルリストを閲覧 | いいえ |
|
||||
| `--page` | リモートリストのページ番号 | 1 |
|
||||
|
||||
## search
|
||||
|
||||
スキル広場でスキルを検索します。
|
||||
|
||||
<CodeGroup>
|
||||
```text チャット
|
||||
/skill search pptx
|
||||
```
|
||||
|
||||
```bash ターミナル
|
||||
cow skill search pptx
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
## install
|
||||
|
||||
統一された `install` コマンドで、Cow スキル広場、GitHub、ClawHub、任意の URL（zip アーカイブ、SKILL.md リンク）からスキルをワンクリックでインストールできます。手動ダウンロードや設定は不要です。
|
||||
|
||||
**スキル広場からインストール（推奨）：**
|
||||
|
||||
<CodeGroup>
|
||||
```text チャット
|
||||
/skill install pptx
|
||||
```
|
||||
|
||||
```bash ターミナル
|
||||
cow skill install pptx
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
**GitHub からインストール：**
|
||||
|
||||
<CodeGroup>
|
||||
```text チャット
|
||||
# リポジトリ内のすべてのスキルをインストール（SKILL.md を含むサブディレクトリを自動検出）
|
||||
/skill install larksuite/cli
|
||||
|
||||
# サブディレクトリを指定して単一スキルをインストール
|
||||
/skill install https://github.com/larksuite/cli/tree/main/skills/lark-im
|
||||
|
||||
# # でサブディレクトリを指定
|
||||
/skill install larksuite/cli#skills/lark-minutes
|
||||
```
|
||||
|
||||
```bash ターミナル
|
||||
# リポジトリ内のすべてのスキルをインストール（SKILL.md を含むサブディレクトリを自動検出）
|
||||
cow skill install larksuite/cli
|
||||
|
||||
# サブディレクトリを指定して単一スキルをインストール
|
||||
cow skill install https://github.com/larksuite/cli/tree/main/skills/lark-im
|
||||
|
||||
# # でサブディレクトリを指定
|
||||
cow skill install larksuite/cli#skills/lark-minutes
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
完全な GitHub URL と `owner/repo` 省略形に対応しています。モノリポ（1つのリポジトリに複数のスキル）の場合、サブディレクトリを省略するとすべてのスキルを自動検出して一括インストールします。サブディレクトリを指定した場合は、そのスキルのみをインストールします。
|
||||
|
||||
**ClawHub からインストール：**
|
||||
|
||||
<CodeGroup>
|
||||
```text チャット
|
||||
/skill install clawhub:baidu-search
|
||||
```
|
||||
|
||||
```bash ターミナル
|
||||
cow skill install clawhub:baidu-search
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
**URL からインストール：**
|
||||
|
||||
<CodeGroup>
|
||||
```text チャット
|
||||
# zip アーカイブからインストール（単一またはバッチ）
|
||||
/skill install https://cdn.link-ai.tech/skills/pptx.zip
|
||||
|
||||
# SKILL.md リンクからインストール
|
||||
/skill install https://example.com/path/to/SKILL.md
|
||||
```
|
||||
|
||||
```bash ターミナル
|
||||
# zip アーカイブからインストール（単一またはバッチ）
|
||||
cow skill install https://cdn.link-ai.tech/skills/pptx.zip
|
||||
|
||||
# SKILL.md リンクからインストール
|
||||
cow skill install https://example.com/path/to/SKILL.md
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
zip / tar.gz アーカイブ URL からのインストールに対応しており、自動的に解凍して `SKILL.md` を含むディレクトリを検出し、単一またはバッチインストールをサポートします。`SKILL.md` ファイルの URL から直接インストールすることもでき、スキル名と説明を自動的に解析します。
|
||||
|
||||
## uninstall
|
||||
|
||||
インストール済みスキルをアンインストールします。
|
||||
|
||||
<CodeGroup>
|
||||
```text チャット
|
||||
/skill uninstall pptx
|
||||
```
|
||||
|
||||
```bash ターミナル
|
||||
cow skill uninstall pptx
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
<Warning>
|
||||
アンインストールするとスキルディレクトリ内のすべてのファイルが削除されます。この操作は元に戻せません。
|
||||
</Warning>
|
||||
|
||||
## enable / disable
|
||||
|
||||
スキルの有効化・無効化を行います。無効化されたスキルは Agent から呼び出されません。
|
||||
|
||||
<CodeGroup>
|
||||
```text チャット
|
||||
/skill enable pptx
|
||||
/skill disable pptx
|
||||
```
|
||||
|
||||
```bash ターミナル
|
||||
cow skill enable pptx
|
||||
cow skill disable pptx
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
## info
|
||||
|
||||
インストール済みスキルの詳細情報を表示します。`SKILL.md` のプレビューを含みます。
|
||||
|
||||
<CodeGroup>
|
||||
```text チャット
|
||||
/skill info pptx
|
||||
```
|
||||
|
||||
```bash ターミナル
|
||||
cow skill info pptx
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
## スキルのソース
|
||||
|
||||
インストールされたスキルはソース情報を記録しており、`/skill list` で確認できます：
|
||||
|
||||
| ソース | 説明 |
|
||||
| --- | --- |
|
||||
| `builtin` | プロジェクト内蔵スキル |
|
||||
| `cowhub` | CowAgent Skill Hub からインストール |
|
||||
| `github` | GitHub URL から直接インストール |
|
||||
| `clawhub` | ClawHub からインストール |
|
||||
| `url` | SKILL.md URL からインストール |
|
||||
| `local` | ローカルで作成されたスキル |
|
||||
Reference in New Issue
Block a user