使用说明

Kwaak是一个开源的AI自主代理平台，旨在帮助开发者自动化代码维护和改进任务。它允许你在本地机器上运行多个AI代理，并行处理代码相关的任务，例如代码编写、测试、改进代码质量和更新文档等。你可以通过类似聊天的终端界面与Kwaak进行交互。

主要功能点:

并行运行多代理: Kwaak可以同时运行多个AI代理，加速任务处理。
代码库感知: Kwaak能够理解你的代码库，回答关于代码的问题，查找示例，并进行代码编写和执行。
工具扩展性: 通过MCP协议，Kwaak可以扩展各种社区提供的工具，例如 '@modelcontextprotocol/server-everything'，从而增强其功能。
多种模型支持: 支持OpenAI, Ollama, Anthropic, Azure等多种LLM模型，并可通过OpenRouter利用更多模型。
代码沙箱执行: 使用Docker提供安全的代码执行环境。
多语言支持: 支持Python, TypeScript/Javascript, Go, Java, Ruby, Rust, C, C++ 和 Solidity等多种编程语言。

安装步骤:

Kwaak提供了多种安装方式，你可以根据你的系统环境选择合适的安装方法。

Homebrew (MacOS):

brew install bosun-ai/tap/kwaak

Linux 和 MacOS (curl):

 curl --proto '=https' --tlsv1.2 -LsSf https://github.com/bosun-ai/kwaak/releases/latest/download/kwaak-installer.sh | sh

Cargo:

cargo binstall kwaak

或者从源代码编译:

cargo install kwaak

Arch Linux:
```
pacman -S kwaak
```

安装完成后，在你的项目根目录下运行 'kwaak init' 初始化配置。

服务器配置 (MCP工具扩展):

Kwaak通过MCP协议支持工具扩展。你可以在 'kwaak.toml' 文件中配置MCP服务器来扩展Kwaak的功能。以下是一个配置示例，用于集成 '@modelcontextprotocol/server-everything' MCP服务器：

[[mcp]]
# MCP服务器名称，方便识别
name = "server-everything"
# 启动MCP服务器的命令
command = "npx"
# 启动命令的参数
args = ["-y", "@modelcontextprotocol/server-everything"]

# (可选) 工具过滤器，例如只允许使用 "add" 工具
filter = { type = "whitelist", tool_names = ["add"] }

# (可选) 环境变量配置，例如设置API密钥
[mcp.env]
SECRET_CALCULATOR_API_KEY = "env:SECRET_CALCULATOR_API_KEY"

配置参数说明:

'name': MCP服务器的自定义名称。
'command': 启动MCP服务器的命令，例如 'npx' 或 'python'。
'args': 传递给启动命令的参数，以列表形式提供。
'filter': (可选) 工具过滤器，用于限制允许使用的工具。
- 'type': 过滤器类型，可以是 'whitelist' (白名单) 或 'blacklist' (黑名单)。
- 'tool_names': 工具名称列表，根据 'type' 决定是允许还是禁止列表中的工具。
'env': (可选) 环境变量配置，用于MCP服务器运行时需要的环境变量。
- 键值对形式，键为环境变量名，值为环境变量值。环境变量值可以使用 'env:', 'text:', 'file:' 前缀来分别从环境变量、文本字符串或文件中读取密钥。

配置完成后，你可以使用 'kwaak --allow-dirty list-tools' 命令来查看已注册的MCP工具。

基本使用方法:

在项目根目录下运行 'kwaak' 启动Kwaak。
Kwaak启动后，将索引你的代码库，初次启动可能较慢。
在终端界面中，你可以像聊天一样与AI代理交互。
使用 'ctrl-s' 发送消息，'ctrl-x' 退出代理，'/help' 查看更多命令。

关键词:

AI代理, 代码自动化, 代码维护, 开发者工具, MCP

关键词

使用说明

信息