跳到主要内容

配置文件说明

CSGLite 的运行环境与参数由一个 JSON 格式的配置文件管理。配置文件在首次启动客户端时会自动创建,供用户自定义存储目录、访问凭证及 API 服务监听地址等。


配置文件路径

  • 路径: ~/.csghub-lite/config.json (对应用户主目录下的 .csghub-lite 文件夹中)

配置文件 JSON 结构示例

{
"server_url": "https://hub.opencsg.com",
"ai_gateway_url": "https://ai.space.opencsg.com",
"token": "your-access-token-here",
"listen_addr": ":11435",
"model_dir": "/Users/user/.csghub-lite/models",
"dataset_dir": "/Users/user/.csghub-lite/datasets"
}

提示:命令行及 Web 设置页面提供了一个便捷的配置项 storage_dir(默认值为 ~/.csghub-lite)。当您设置 storage_dir 时,系统会自动将实际的模型和数据集目录派生为 model_dir<storage_dir>/models)与 dataset_dir<storage_dir>/datasets)。


配置项详解

1. server_url

CSGHub 平台的官方或私有部署 API 地址。

  • 默认值: https://hub.opencsg.com
  • 说明: 模型搜索、元数据查询、以及文件下载的基础 API 地址。
  • 命令行修改示例:
    csghub-lite config set server_url https://my-private-csghub.example.com

2. ai_gateway_url

云端推理模型所使用的 AI 网关(AI Gateway)地址。

  • 默认值: https://ai.space.opencsg.com
  • 说明: 支持覆盖默认的云端模型调用路径,适用于私有化部署。
  • 命令行修改示例:
    csghub-lite config set ai_gateway_url https://my-gateway.example.com

3. token

用于访问传神社区上私有模型和私有数据集的访问令牌(Access Token)。

  • 默认值: (空)
  • 说明: 设置后会自动在拉取私有资产时加入身份认证信息。
  • 设置方法:
    # 方式 A:交互式登录(推荐,Token 不会遗留在 shell 历史命令中)
    csghub-lite login

    # 方式 B:使用 config 命令直接设置
    csghub-lite config set token your_token_here

4. listen_addr

本地 REST API 服务启动时的默认监听地址和端口。

  • 默认值: :11435
  • 说明: 格式为 [IP地址]:[端口号]
  • 命令行修改示例:
    # 1. 变更默认端口
    csghub-lite config set listen_addr :8080

    # 2. 限制服务仅监听本地回环地址
    csghub-lite config set listen_addr 127.0.0.1:11435

5. storage_dir

本地模型和数据集共同使用的共享存储根目录。

  • 默认值: ~/.csghub-lite
  • 说明: 方便将大量模型和数据集统一移动到外部大容量磁盘(例如外接 SSD)。
  • 命令行修改示例:
    csghub-lite config set storage_dir /Volumes/ExternalSSD/csghub-lite

6. model_dir / dataset_dir

实际生效的模型文件和数据集文件存储目录。默认情况下由 storage_dir 自动推导,若有特殊存储结构需求,也可以单独覆盖设置。

  • 命令行修改示例:
    csghub-lite config set model_dir /data/models
    csghub-lite config set dataset_dir /data/datasets

默认目录结构一览

当您首次使用并下载 Qwen3-0.6B-GGUF 模型后,~/.csghub-lite 下的默认文件夹层级结构如下:

~/.csghub-lite/
├── config.json # 客户端配置文件
├── models/ # 本地模型缓存目录
│ └── Qwen/
│ └── Qwen3-0.6B-GGUF/
│ ├── manifest.json # 模型元数据缓存
│ ├── Qwen3-0.6B-Q8_0.gguf # 量化模型权重文件
│ ├── README.md # 对应模型的卡片描述
│ └── LICENSE # 模型的许可证文件
└── datasets/ # 本地数据集缓存目录