走秀台

一个用于 Crush 兼容模型的数据库。

你希望在 Crush 中看到哪个提供商？有没有现有的模型需要更新？这是一个由社区支持的项目，我们欢迎并鼓励大家贡献代码。

你的想法？

我们非常想听听你对这个项目的看法。需要帮助吗？我们随时为你提供支持。你可以在以下地方找到我们：

• Twitter
• Discord
• Slack
• Fediverse

许可证

MIT

---

Charm 的一部分 Charm。

Charm 热爱开源 • Charm loves open source

Catwalk 快速上手指南

Catwalk 是一个专为 Crush 兼容模型设计的数据库项目。它由社区驱动，旨在收录和管理可在 Crush 中使用的 AI 模型提供商信息。

注意：根据当前 README 内容，Catwalk 主要作为一个模型注册表/数据库存在，供 Crush 工具读取。以下指南侧重于如何获取该项目源码及参与贡献。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows (WSL2 推荐)
• 前置依赖：
  • Git：用于克隆代码仓库
  • (可选) Go：如果您计划构建或修改相关工具链（Crush 生态通常基于 Go）

安装步骤

由于 Catwalk 是一个数据仓库项目，主要通过克隆源码方式使用：

1. 克隆仓库 打开终端，执行以下命令将项目拉取到本地：

   git clone https://github.com/charmbracelet/catwalk.git
   

2. 进入目录

   cd catwalk
   

3. 查看模型数据 项目核心数据通常存储在特定格式的文件中（如 YAML 或 JSON），您可以直接浏览仓库文件结构来查看支持的模型列表。

基本使用

Catwalk 的主要用途是作为 Crush 的后端数据源。

1. 配合 Crush 使用

确保您已安装最新版的 crush 工具。Catwalk 中的数据会被 Crush 自动识别（具体集成方式取决于 Crush 的版本配置）。

# 示例：运行 crush 并尝试访问 Catwalk 中定义的模型
crush

2. 贡献新模型

如果您希望添加新的模型提供商或更新现有模型信息：

• 在本地仓库中找到对应的数据配置文件。
• 按照现有格式添加新的条目。
• 提交 Pull Request 至上游仓库。

# 创建新分支进行贡献
git checkout -b add-new-model

# 编辑完成后提交
git add .
git commit -m "feat: add new model provider"
git push origin add-new-model

---

更多社区交流与支持，请访问 Charm 官方 Discord 或 Twitter。