oedp命令行设计 & 使用说明 ​

oedp ​

oedp info ​

查看项目的详细信息，默认为当前路径。

oedp run [action] ​

执行项目某个方法，默认为当前路径；[action]为插件可使用的方法，可通过 oedp info命令查询。

oedp list ​

列举插件源中可用的插件。

oedp init [plugin] ​

插件初始化到指定路径，[plugin]可以是插件压缩包路径、插件下载地址、插件名称。

• [plugin]如果为本地的插件压缩包（以tar.gz结尾），则直接初始化到指定路径。
• [plugin]如果为插件下载地址（以tar.gz结尾），则先下载到缓存路径/var/oedp/plugin/，再初始化到指定路径。
• [plugin]如果为插件名称，从已经配置的插件源中查找，下载到缓存路径后初始化到指定路径。

示例：假设当前路径为家目录~，如下5个命令执行后，都是初始化了一个目录为~/kubernetes-1.31.1的 oeDeploy 插件。

oedp init kubernetes-1.31.1
oedp init kubernetes-1.31.1.tar.gz
oedp init https://repo.oepkgs.net/openEuler/rpm/openEuler-24.03-LTS/contrib/oedp/plugins/kubernetes-1.31.1.tar.gz
oedp init kubernetes-1.31.1 -p ~/kubernetes-1.31.1
oedp init kubernetes-1.31.1 -d ~

oedp repo ​

插件源管理。

• 支持本地插件源、远端插件源。
• 插件源不可重名。

插件源配置文件 /etc/oedp/config/repo/repo.conf示例。

[openEuler]
url = https://repo.oepkgs.net/openEuler/rpm/openEuler-24.03-LTS/contrib/oedp/plugins/
enabled = true

[local]
url = file:///root/.oedp/plugins/
enabled = false

oedp工具相关文件与路径 ​

oeDeploy 插件源 ​

插件源格式说明 ​

oeDeploy 支持从可访问的插件源自动获取安装部署插件，并初始化到本地。

插件源的根目录下必须有一个索引文件 index.yaml，其描述了当前插件源中所有可访问插件的具体信息，包括下载地址。

oeDeploy 提供了 oedp repo make 和 oedp repo make-local 命令，用于自动生成 index.yaml。

index.yaml示例如下：

apiversion: v1
plugins:
- anythingLLM:
  - name: anythingLLM
    version: 1.0.0
    updated: 2025-07-26T17:43:28+0800
    author: ''
    url: https://gitee.com/openeuler/oeDeploy/tree/master/plugins/anythingLLM
    description: oeDeploy plugin for anythingLLM fast deployment
    description_zh: 用于anythingLLM快速部署的oeDeploy插件
    description_en: oeDeploy plugin for anythingLLM fast deployment
    readme: ''
    icon: ''
    localhost_available: true
    type: app
    sha256sum: 54f22780afadd02559e4a5bfdf672c6f2af1f17a73fe08fc4e3cd82aeee0cdef
    size: 12820
    urls:
    - https:/repo.oepkgs.net/openEuler/rpm/openEuler-24.03-LTS/contrib/oedp/plugins/anythingLLM.tar.gz
- deepseek-r1:
  - name: deepseek-r1
    version: 1.0.0
    updated: 2025-05-27T21:33:00+0800
    author: ''
    url: ''
    description: deepseek-r1 1.0.0
    description_zh: ''
    description_en: ''
    readme: ''
    icon: ''
    localhost_available: false
    type: app
    sha256sum: 9c991734052aa32c2ca362835115c6f2cb51026226f0aecbfeda134348812408
    size: 4787
    urls:
    - https:/repo.oepkgs.net/openEuler/rpm/openEuler-24.03-LTS/contrib/oedp/plugins/deepseek-r1.tar.gz

首层字段含义：

插件字段含义：

插件源构建方式 ​

方式1：使用 oedp repo make 命令 ​

执行如下命令，一键生成索引文件 index.yaml：

oedp repo make [plugins_dir] [url_prefix] [output_dir] [extra_item]

• plugins_dir表示当前 Linux 环境下的插件源根目录，命令会自动识别目录下（包括所有子目录）所有符合条件的 oeDeploy 插件（后缀为.tar.gz的压缩包）。

• url_prefix表示每个插件源的 url 索引前缀，即对外暴露的插件源根目录。

• output_dir表示索引文件 index.yaml输出的目录。

• extra_item（可选）表示额外补充项的YAML文件路径，用于合并额外的插件版本信息到索引中。

命令会自动处理以下情况：

1. 合并主目录和额外文件中的插件版本
2. 按版本号从大到小排序
3. 自动去重相同插件名和版本号的条目

例如，假设当前 Linux 环境上 /root/build_workspace/storages/plugins目录中有多个 oeDeploy 插件，且该目录映射到 http://x.x.x.x:8080/plugins，作为文件服务器对外暴露。

未存储在当前环境的oeDeploy插件信息记录在 /root/build_workspace/storages/extra.yaml。

执行如下命令，可以在 /root/build_workspace/storages/plugins目录下生成一个 index.yaml，其中每个插件的 urls字段是其在文件服务器上的真实访问地址，可以直接下载。

oedp repo make \
/root/build_workspace/storages/plugins \
http://x.x.x.x:8080/plugins \
/root/build_workspace/storages/plugins \
/root/build_workspace/storages/extra.yaml

方式2：使用 oedp repo make-local 命令 ​

对于本地插件源，可以使用更简便的命令：

oedp repo make-local [path]

• path（可选）表示插件目录路径，默认为当前目录。命令会自动转换为绝对路径。

此命令等价于 oedp repo make path file://path path，适用于本地插件源的快速构建。

例如，在 /opt/oedp/plugins 目录下生成本地插件源索引：

cd /opt/oedp/plugins
oedp repo make-local

或者：

oedp repo make-local /opt/oedp/plugins