docs

csghub-lite 文档

csghub-lite 是一个轻量级的本地大语言模型运行工具，基于 CSGHub 平台的模型生态。

文档目录

快速上手

• 安装指南 — 多种安装方式：一键脚本、Homebrew（主要面向 macOS）、源码编译
• 快速入门 — 5 分钟上手：搜索、下载、对话、启动 API

CLI 命令参考

• 命令总览 — 所有命令一览表
• run — 自动下载并交互对话
• chat — 与本地模型交互对话
• serve — 启动 REST API 服务
• pull — 下载模型
• list — 列出本地模型
• show — 查看模型详情
• ps — 查看运行中的模型
• stop — 停止运行中的模型
• rm — 删除本地模型
• search — 搜索 CSGHub 模型
• login — 设置访问令牌
• config — 配置管理

REST API 参考

• API 总览 — 端点列表与通用说明
• Chat 对话接口 — POST /api/chat
• Generate 生成接口 — POST /api/generate
• 模型管理接口 — tags / show / pull / delete / ps / stop

使用指南

• 配置说明 — 配置文件、私有化部署、环境变量
• 模型格式 — GGUF / SafeTensors 格式说明与转换
• 打包与发布 — GoReleaser、Homebrew（主要面向 macOS）、安装脚本
• 架构设计 — 项目结构与模块设计