rubick/docs/docs/guide/README.md

赞助

rubick 是非盈利项目，开源不容易，如果该项目对你有用的话，可以打赏我们喝杯 coffee ☕️.

前言

rubick 之前的插件管理，依托于云服务器存储，我们需要为服务器存储支付一笔不小的开销。 由于项目完全开源，所以几乎无任何收入，所以为了让 rubick 先生存下去，我们再三抉择把插件包管理方式托管到了npm 上。

由于 rubick 的插件管理体系是基于 npm 的包管理体系，所以当您需要使用插件的时候，需要手动保证当前电脑已经安装好了node环境。 如果当前电脑已经安装过 node，那么您可以直接下载 rubick 进行使用啦！

macos 下安装 nodejs 方法

windows 下安装 nodejs 方法

下载 rubick

rubick 下载安装地址

macos 选择 pkg 文件，windows 选择 exe 文件，Debian/Ubuntu选择deb。 安装完成后打开 rubick 即可看到主搜索界面：

功能说明

接下来详细介绍 rubick 所包含和支持的功能

1. 搜索系统应用

支持拼音和缩写来搜索系统安装应用：

2. UI类插件安装

点击搜索框右侧 rubick 图标，进入插件市场，选择所需插件，点击下载按钮即可下载，下载完成后在已安装 tab 下可以找到安装插件。 安装完成后，输入插件呼起命令即可使用对应插件：

3. 系统类插件安装

系统插件安装方式和UI类一样，在插件市场选择系统分类，寻找适合自己的系统插件安装即可。 ::: danger 系统插件安装成功后，需要重启 rubick 才能生效 :::

4. 输入框聚焦自动根据剪切板内容匹配插件

在 rubick 内搜索偏好设置，然后开启自动粘贴 功能，即可匹配剪切板内容自动匹配适合插件进行使用。

内网部署

::: tip 如果把插件发布到公网 npm 如果不符合您的公司安全要求，rubick 支持内网私有源和私有插件库，如果您需要内网部署使用，可以自行配置以下规则。 ::: rubick 依赖 npm 仓库做插件管理，依赖 gitcode 做插件数据存储，所以如果要进行内网部署，主要需要替换这2个设置。详细设置： 插件市场 -> 设置 -> 内网部署设置

1. 替换 npm 源

插件发布到私有 npm 源即可。

2. 替换 gitcode 源为内网 gitlab: database url

• clone 下载 rubick 插件库：https://gitcode.net/rubickcenter/rubick-database
• 提交仓库到私有 gitlab 库。

替换格式：https://gitlab.xxx.com/api/v4/projects/{projectId}/repository/files/ 。因为接口为 gitlab openAPI，所以需要填写仓库 access_token

更多功能

如果您还需要更多功能，欢迎来这里给我们提建议：issues 。 有价值的想法我们会加入到后期的开发当中。同时也欢迎一起加入共建。