关于本页

本页介绍更夫所基于的开源内核 Keep 的通用能力。更夫在其上提供国内化增强：钉钉/企业微信/飞书通知、国产大模型接入、LDAP 认证与值班管理。部署与上手请看快速上手。

INFO

缺少某个安装方式？提交一个新的安装请求，我们会尽快添加。

INFO

我们建议安装 Keep CLI 时使用 Python 3.11 版本以获得最佳的兼容性和性能。 这个选择确保了与所有依赖项的无缝集成，包括 pyarrow，pyarrow 目前不支持 Python 3.12。

TIP

需要其他版本的 Keep CLI？请联系我们！

克隆并安装（选项 1）

安装

首先，克隆 Keep 仓库：

git clone https://github.com/keephq/keep.git && cd keep

使用 pip 安装 Keep CLI：

# 如果 MacOS 上没有 python 或 pip：
# brew install python@3.11
# brew install postgresql
pip3.11 install .

或使用 poetry：

poetry install

从现在开始，Keep 应该已本地安装并可从命令行访问，通过执行以下命令测试：

keep version

配置

要获取 API 密钥，请访问 Keep UI -> 您的用户名（左下角）-> 设置 -> API 密钥

keep config new --url http://backend.my_keep.my_awesome_org.com:backend_port --api-key your_personal_api_key

测试

现在，

keep workflow apply -f examples/workflows/query_clickhouse.yml

恭喜！🥳 检查您的 UI，应该能看到从 YAML 文件上传的新工作流。

Docker 镜像（选项 2）

安装

docker run -v ${PWD}:/app -v ~/.keep.yaml:/root/.keep.yaml -it us-central1-docker.pkg.dev/keephq/keep/keep-cli keep config new --url http://backend.my_keep.my_awesome_org.com:backend_port --api-key your_personal_api_key

测试

docker run -v ${PWD}:/app -v ~/.keep.yaml:/root/.keep.yaml -it us-central1-docker.pkg.dev/keephq/keep/keep-cli workflow apply -f examples/workflows/query_clickhouse.yml

启用自动补全

Keep 的 CLI 支持 shell 自动补全，这可以让您的生活变得更轻松 😌 如果您使用的是 zsh

eval "$(_KEEP_COMPLETE=zsh_source keep)"

如果您使用的是 bash

eval "$(_KEEP_COMPLETE=bash_source keep)"

INFO

使用 eval 意味着每次启动 shell 时都会调用和评估该命令，这可能会延迟 shell 的响应速度。要加快速度，请将生成的脚本写入文件，然后 source 该文件。