logo
0
0
Login
doc: 更新项目README

Rime Schema 部署工具

这是一个用于自动化部署 Rime 输入法方案的工具,支持通过 Docker 容器、直接运行脚本和 CNB 插件的方式来构建和打包 Rime 方案。

功能特性

  • 🚀 自动安装和配置 Rime 方案
  • 📦 支持用户方案和共享方案的批量安装
  • 🔧 支持作为 CNB 流水线插件
  • 🐳 Docker 容器化支持
  • 🔄 支持环境变量和命令行参数配置

快速开始

使用 Docker(推荐)

  1. 构建 Docker 镜像:
docker build -t rime-deploy .
  1. 运行容器部署方案:
docker run --rm -v $(pwd):/plugin rime-deploy \ --user-recipe-list "Mintimate/oh-my-rime:plum/full" \ --package-items "opencc lua build" \ --zip-file "oh-my-rime-online.zip"

直接运行脚本

确保系统已安装必要依赖:

# Ubuntu/Debian sudo apt install -y librime-bin git zip # 运行部署脚本 ./build.sh --user-recipe-list "Mintimate/oh-my-rime:plum/full" --package-items "opencc lua build" --zip-file "oh-my-rime-online.zip"

CNB 插件

支持在 CNB 流水线中作为插件使用:

- name: 自动打包在线方案包 image: docker.cnb.cool/mintimate/rime/deploy-schema settings: user_recipe_list: 'Mintimate/oh-my-rime:plum/full' package_items: 'build opencc lua' zip_file: oh-my-rime-online.zip

参考: oh-my-rime

配置参数

命令行参数

参数描述默认值
--user-recipe-list用户方案列表(换行分隔)
--shared-recipe-list共享方案列表(换行分隔)
--schema-list方案列表(换行分隔)
--package-items打包项目列表build
--zip-file输出文件名oh-my-rime.zip
-h, --help显示帮助信息-

环境变量

支持通过环境变量配置参数(自动注入 PLUGIN_ 前缀):

  • PLUGIN_USER_RECIPE_LIST
  • PLUGIN_SHARED_RECIPE_LIST
  • PLUGIN_SCHEMA_LIST
  • PLUGIN_PACKAGE_ITEMS
  • PLUGIN_ZIP_FILE

目录结构

. ├── Dockerfile # Docker 镜像构建文件 ├── build.sh # 主要的部署脚本 ├── .cnb.yml # CNB 配置文件 ├── LICENSE # 项目许可证文件 └── README.md # 项目说明文档

许可证

本项目采用 GPL-3.0 许可证。详见 LICENSE 文件。

GPLv3

参考

脚本制作参考自: