使用说明

Kash (“Knowledge Agent SHell”) 是一个交互式的、AI 原生的命令行 Shell,它同时也是一个 Python 库,可以作为 MCP 服务器运行,为 LLM 客户端提供工具服务。

主要功能点:

  • Actions (操作): Kash 的核心是操作,通过装饰 Python 函数,可以将其转换为 Kash 操作,使其能够处理文件输入和输出,并与工作区集成。
  • 组合性: 操作可以像 Python 函数一样组合使用,构建复杂的工作流程,例如视频转录和注释可以由下载视频、识别发言人等简单操作组合而成。
  • 命令行使用: Kash 操作也是命令行工具,可以在 Kash Shell 中像其他 shell 命令一样调用,并具有智能 Tab 补全、Python 表达式和内置 LLM 助手等功能。
  • MCP 服务器: Kash 操作可以作为 MCP 工具服务器运行,与 Anthropic Desktop 或 Cursor 等 MCP 客户端集成,将 Kash 的功能以工具的形式提供给这些客户端。
  • API 兼容性: Kash 工具与 API 无关,可以在本地运行,支持多种模型和 API,包括 OpenAI GPT-4o, Anthropic Claude 3.7, Google Gemini 等,并可通过 LiteLLM 扩展支持更多模型。

安装步骤:

  1. 安装 uv 和 Python: 推荐使用 uv 包管理器安装 Python 和 kash,uv 可以替代 pyenv, pipx, poetry, pip 等工具。可以使用以下命令安装 uv:

    curl -LsSf https://astral.sh/uv/install.sh | sh

    macOS 用户可以使用 brew 安装:

    brew update
    brew install uv
  2. 安装额外的命令行工具 (可选): 推荐安装 ripgrep, bat, eza, hexyl, imagemagick, libmagic, ffmpeg 等工具,以增强 Kash 的功能。macOS 用户可以使用 brew 安装:

    brew update
    brew install ripgrep bat eza hexyl imagemagick libmagic ffmpeg

    Ubuntu 用户可以使用 apt 安装:

    apt install ripgrep bat eza hexyl imagemagick libmagic ffmpeg
  3. 安装 kash-media 工具包: 安装包含媒体工具的 kash 工具包,如果只需要基本功能,可以安装 'kash-shell'。

    uv tool install kash-media --python=3.13
  4. 设置 API 密钥: 根据需要使用的 AI 服务,设置相应的 API 密钥,例如 OpenAI, Anthropic, Groq, Deepgram 等。可以将密钥添加到 '.env' 文件中。

    cp .env.template .env
    # 编辑 .env 文件,添加 API 密钥
  5. 运行 Kash Shell:

    kash

服务器配置 (MCP 客户端):

要将 Kash 作为 MCP 服务器与客户端(如 Anthropic Desktop 或 Cursor)连接,需要在 MCP 客户端中配置服务器信息。以下是 Claude Desktop 的配置示例:

{
  "mcpServers": {
    "kash": {
      "command": "/Users/levy/.local/bin/kash_mcp",
      "args": ["--proxy"]
    }
  }
}
  • server name: 'kash' (服务器名称,可以自定义)
  • command: '/Users/levy/.local/bin/kash_mcp' (kash_mcp 启动命令的绝对路径,请根据实际安装路径修改)
  • args: '["--proxy"]' (启动参数,'--proxy' 参数使 kash_mcp 作为代理服务器连接到 Kash Shell 中运行的 MCP SSE 服务器)

基本使用方法:

  1. 运行 Kash MCP 服务器: 在 Kash Shell 中,使用 'start_mcp_server' 命令启动 MCP SSE 服务器。
  2. 配置 MCP 客户端: 在 MCP 客户端中,根据上述服务器配置信息,添加 Kash MCP 服务器。
  3. 使用 MCP 客户端调用 Kash 工具: 配置完成后,即可在 MCP 客户端中像调用其他工具一样调用 Kash 操作,例如在 Claude Desktop 中提问 “can you transcribe this video?” 并提供视频 URL,即可调用 'transcribe' 操作进行视频转录。
  4. 工作区和数据管理: Kash 的所有操作都在工作区中进行,输入和输出都保存在当前工作区目录中,方便用户管理和切换工作环境。

信息

分类

开发者工具