docs(plugins): use local install paths (#552)

This commit is contained in:
jinliyl 2026-09-15 20:15:52 +08:00 • committed by GitHub
parent 5f2c693ddb
commit 6c5d2194c0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
13 changed files with 29 additions and 29 deletions

View file

@ -250,9 +250,9 @@ Plugin packages are managed locally and remain separate from per-application act
```bash
reme plugins list
reme plugins install reme-dingtalk
reme plugins install reme-auto-fin
reme plugins install reme-daily-paper
reme plugins install plugins/dingtalk
reme plugins install plugins/auto-fin
reme plugins install plugins/daily_paper
reme plugins show daily-paper
reme plugins validate daily-paper
reme plugins uninstall daily-paper

View file

@ -72,17 +72,17 @@ by another running process is not a global enable state.
## Install a plugin package
Install a published distribution:
Install a published distribution by its package name:
```bash
reme plugins install reme-auto-fin
reme plugins install your-plugin-package
```
Install or upgrade a pinned version:
```bash
reme plugins install 'reme-auto-fin==X.Y.Z'
reme plugins install reme-auto-fin --upgrade
reme plugins install 'your-plugin-package==X.Y.Z'
reme plugins install your-plugin-package --upgrade
```
Install a local plugin project:

View file

@ -71,7 +71,7 @@ Package management runs locally rather than through HTTP or MCP:
reme plugins list
reme plugins show auto-fin
reme plugins validate auto-fin
reme plugins install reme-auto-fin
reme plugins install plugins/auto-fin
reme plugins uninstall auto-fin
```

View file

@ -239,9 +239,9 @@ entry-point 名称就是插件标识;使用
```bash
reme plugins list
reme plugins install reme-dingtalk
reme plugins install reme-auto-fin
reme plugins install reme-daily-paper
reme plugins install plugins/dingtalk
reme plugins install plugins/auto-fin
reme plugins install plugins/daily_paper
reme plugins show daily-paper
reme plugins validate daily-paper
reme plugins uninstall daily-paper

View file

@ -68,17 +68,17 @@ reme plugins list --config default
## 安装插件包
安装已发布的 distribution:
使用包名安装已发布的 distribution:
```bash
reme plugins install reme-auto-fin
reme plugins install your-plugin-package
```
安装指定版本或升级:
```bash
reme plugins install 'reme-auto-fin==X.Y.Z'
reme plugins install reme-auto-fin --upgrade
reme plugins install 'your-plugin-package==X.Y.Z'
reme plugins install your-plugin-package --upgrade
```
安装本地插件项目:

View file

@ -71,7 +71,7 @@ reme find_reme
reme plugins list
reme plugins show auto-fin
reme plugins validate auto-fin
reme plugins install reme-auto-fin
reme plugins install plugins/auto-fin
reme plugins uninstall auto-fin
```

View file

@ -18,7 +18,7 @@ through `plugins=["auto-fin"]`.
```bash
python -m pip install "reme-ai[core]>=0.4.1.12"
reme plugins install reme-auto-fin
reme plugins install plugins/auto-fin
```
### 2. Configure the model environment

View file

@ -15,7 +15,7 @@ distribution:单个 `reme.plugins` entry point 暴露 `plugin.yaml`,其中
```bash
python -m pip install "reme-ai[core]>=0.4.1.12"
reme plugins install reme-auto-fin
reme plugins install plugins/auto-fin
```
### 2. 配置模型环境变量

View file

@ -14,7 +14,7 @@ their Job configuration under `application_defaults`. Enable the installed plugi
```bash
python -m pip install "reme-ai[core]>=0.4.1.12"
reme plugins install reme-daily-paper
reme plugins install plugins/daily_paper
```
### 2. Configure the model environment

View file

@ -12,7 +12,7 @@ Step backend,并在 `application_defaults` 下提供 Job 配置;通过 `plug
```bash
python -m pip install "reme-ai[core]>=0.4.1.12"
reme plugins install reme-daily-paper
reme plugins install plugins/daily_paper
```
### 2. 配置模型环境变量

View file

@ -13,7 +13,7 @@ Install ReMe and the plugin:
```bash
python -m pip install "reme-ai[core]>=0.4.1.12"
reme plugins install reme-dingtalk
reme plugins install plugins/dingtalk
reme plugins validate dingtalk
```
@ -29,8 +29,8 @@ DINGTALK_CONVERSATION_IDS=cid-group-one,cid-group-two
The repository's `cookbook` config composes DingTalk with the independently installed Auto Fin and Daily Paper plugins:
```bash
reme plugins install reme-auto-fin
reme plugins install reme-daily-paper
reme plugins install plugins/auto-fin
reme plugins install plugins/daily_paper
reme start config=cookbook
```

View file

@ -13,7 +13,7 @@
```bash
python -m pip install "reme-ai[core]>=0.4.1.12"
reme plugins install reme-dingtalk
reme plugins install plugins/dingtalk
reme plugins validate dingtalk
```
@ -29,8 +29,8 @@ DINGTALK_CONVERSATION_IDS=cid-group-one,cid-group-two
仓库内置的 `cookbook` 配置会组合钉钉、Auto Fin 和 Daily Paper 三个独立安装的插件:
```bash
reme plugins install reme-auto-fin
reme plugins install reme-daily-paper
reme plugins install plugins/auto-fin
reme plugins install plugins/daily_paper
reme start config=cookbook
```

View file

@ -8,9 +8,9 @@ app_name: ReMe Cookbook
# This configuration composes three independently installable plugins. Install
# all three packages into the same Python environment as the `reme` command:
#
# reme plugins install reme-dingtalk
# reme plugins install reme-auto-fin
# reme plugins install reme-daily-paper
# reme plugins install plugins/dingtalk
# reme plugins install plugins/auto-fin
# reme plugins install plugins/daily_paper
#
# Create a `.env` file in the directory where `reme start` will run (or export
# the variables in the shell). These DingTalk application credentials are