mirror of
https://github.com/zhayujie/chatgpt-on-wechat.git
synced 2026-07-19 12:47:25 +08:00
docs: add CLI system docs
This commit is contained in:
zhayujie
@@ -30,7 +30,25 @@ pip3 install -r requirements.txt
|
||||
pip3 install -r requirements-optional.txt
|
||||
```
|
||||
|
||||
### 3. 設定
|
||||
### 3. Cow CLI をインストール
|
||||
|
||||
サービスとスキルを管理するためのコマンドラインツールをインストールします：
|
||||
|
||||
```bash
|
||||
pip3 install -e .
|
||||
```
|
||||
|
||||
インストール後、`cow` コマンドが使用可能になります：
|
||||
|
||||
```bash
|
||||
cow help
|
||||
```
|
||||
|
||||
<Note>
|
||||
このステップは推奨です。インストール後、`cow start`、`cow stop`、`cow update` でサービスを管理でき、`cow skill` でスキルを管理できます。CLI をインストールしない場合は、`./run.sh` または `python3 app.py` で実行できます。
|
||||
</Note>
|
||||
|
||||
### 4. 設定
|
||||
|
||||
設定テンプレートをコピーして編集します：
|
||||
|
||||
@@ -40,22 +58,32 @@ cp config-template.json config.json
|
||||
|
||||
`config.json` にモデルの API キー、チャネルタイプ、その他の設定を入力します。詳細は[モデルのドキュメント](/ja/models/index)を参照してください。
|
||||
|
||||
### 4. 実行
|
||||
### 5. 実行
|
||||
|
||||
**ローカルで実行：**
|
||||
**Cow CLI を使用して実行（推奨）：**
|
||||
|
||||
```bash
|
||||
cow start
|
||||
```
|
||||
|
||||
**またはローカルでフォアグラウンド実行：**
|
||||
|
||||
```bash
|
||||
python3 app.py
|
||||
```
|
||||
|
||||
デフォルトではWebサービスが起動します。`http://localhost:9899/chat` にアクセスしてチャットできます。
|
||||
デフォルトでは Web コンソールが起動します。`http://localhost:9899` にアクセスしてチャットできます。
|
||||
|
||||
**サーバーでバックグラウンド実行：**
|
||||
**サーバーでバックグラウンド実行（CLI 未使用時）：**
|
||||
|
||||
```bash
|
||||
nohup python3 app.py & tail -f nohup.out
|
||||
```
|
||||
|
||||
<Tip>
|
||||
サーバーにデプロイする場合は、ファイアウォールまたはセキュリティグループでポート `9899` を開放して Web コンソールにアクセスできるようにしてください。セキュリティのため、特定の IP のみにアクセスを制限することを推奨します。
|
||||
</Tip>
|
||||
|
||||
## Docker によるデプロイ
|
||||
|
||||
Docker デプロイでは、ソースコードのクローンや依存パッケージのインストールは不要です。Agent モードを使用する場合は、より広範なシステムアクセスが可能なソースコードによるデプロイを推奨します。
|
||||
@@ -84,6 +112,10 @@ sudo docker compose up -d
|
||||
sudo docker logs -f chatgpt-on-wechat
|
||||
```
|
||||
|
||||
<Tip>
|
||||
サーバーにデプロイする場合は、ファイアウォールまたはセキュリティグループでポート `9899` を開放して Web コンソールにアクセスできるようにしてください。セキュリティのため、特定の IP のみにアクセスを制限することを推奨します。
|
||||
</Tip>
|
||||
|
||||
## 主要な設定項目
|
||||
|
||||
```json
|
||||
|
||||
@@ -18,22 +18,27 @@ bash <(curl -fsSL https://cdn.link-ai.tech/code/cow/run.sh)
|
||||
1. Python環境の確認（Python 3.7以上が必要）
|
||||
2. 必要なツールのインストール（git、curlなど）
|
||||
3. プロジェクトを `~/chatgpt-on-wechat` にクローン
|
||||
4. Pythonの依存パッケージをインストール
|
||||
4. Pythonの依存パッケージと Cow CLI をインストール
|
||||
5. AIモデルとチャネルの対話式設定
|
||||
6. サービスの起動
|
||||
|
||||
デフォルトでは、インストール後にWebサービスが起動します。`http://localhost:9899/chat` にアクセスしてチャットを開始できます。
|
||||
デフォルトでは、インストール後に Web コンソールが起動します。`http://localhost:9899` にアクセスしてチャットを開始できます。
|
||||
|
||||
## 管理コマンド
|
||||
|
||||
インストール後、以下のコマンドでサービスを管理できます：
|
||||
インストール後、`cow` コマンドでサービスを管理できます：
|
||||
|
||||
| コマンド | 説明 |
|
||||
| --- | --- |
|
||||
| `./run.sh start` | サービスを起動 |
|
||||
| `./run.sh stop` | サービスを停止 |
|
||||
| `./run.sh restart` | サービスを再起動 |
|
||||
| `./run.sh status` | 実行状態を確認 |
|
||||
| `./run.sh logs` | リアルタイムログを表示 |
|
||||
| `./run.sh config` | 再設定 |
|
||||
| `./run.sh update` | プロジェクトコードを更新 |
|
||||
| `cow start` | サービスを起動 |
|
||||
| `cow stop` | サービスを停止 |
|
||||
| `cow restart` | サービスを再起動 |
|
||||
| `cow status` | 実行状態を確認 |
|
||||
| `cow logs` | リアルタイムログを表示 |
|
||||
| `cow update` | コードを更新して再起動 |
|
||||
|
||||
詳細は[コマンドドキュメント](/ja/commands/index)を参照してください。
|
||||
|
||||
<Note>
|
||||
`cow` コマンドが利用できない場合は、`./run.sh <コマンド>`（例：`./run.sh start`、`./run.sh stop`）で代替できます。機能は同等です。
|
||||
</Note>
|
||||
|
||||
@@ -3,20 +3,25 @@ title: アップデート
|
||||
description: CowAgent のアップグレード方法
|
||||
---
|
||||
|
||||
## スクリプトによるアップグレード（推奨）
|
||||
## コマンドによるアップグレード（推奨）
|
||||
|
||||
`run.sh` でサービスを管理している場合、以下のコマンドでワンクリックアップグレードできます：
|
||||
`cow update` でコードの更新とサービスの再起動をワンクリックで実行できます：
|
||||
|
||||
```bash
|
||||
./run.sh update
|
||||
cow update
|
||||
```
|
||||
|
||||
このコマンドは以下のフローを自動的に実行します：
|
||||
|
||||
1. 現在実行中のサービスを停止
|
||||
2. 最新コードをプル
|
||||
3. 依存関係を再チェック
|
||||
4. サービスを起動
|
||||
1. 最新コードをプル（`git pull`）
|
||||
2. 現在のサービスを停止
|
||||
3. Python 依存パッケージを更新
|
||||
4. CLI を再インストール
|
||||
5. サービスを起動
|
||||
|
||||
<Note>
|
||||
Cow CLI がインストールされていない場合は、`./run.sh update` でも同様の操作が可能です。
|
||||
</Note>
|
||||
|
||||
## 手動アップグレード
|
||||
|
||||
@@ -25,15 +30,19 @@ description: CowAgent のアップグレード方法
|
||||
```bash
|
||||
git pull
|
||||
pip3 install -r requirements.txt
|
||||
pip3 install -e .
|
||||
```
|
||||
|
||||
更新完了後、サービスを再起動します：
|
||||
|
||||
```bash
|
||||
# run.sh で管理している場合
|
||||
# Cow CLI を使用
|
||||
cow restart
|
||||
|
||||
# または run.sh を使用
|
||||
./run.sh restart
|
||||
|
||||
# nohup で直接実行している場合
|
||||
# または nohup で直接実行
|
||||
kill $(ps -ef | grep app.py | grep -v grep | awk '{print $2}')
|
||||
nohup python3 app.py & tail -f nohup.out
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user