# Gitee AI 命令行工具

**Repository Path**: sourceflowai/cli

## Basic Information

- **Project Name**: Gitee AI 命令行工具
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2024-09-10
- **Last Updated**: 2024-09-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Gitee AI 命令行工具（`gai`）

#### 介绍
Gitee AI 命令行工具（`gai`）是一款专为开发者设计的高效工具，帮助用户轻松地将模型和数据集上传到 Gitee AI 平台。


#### 运行环境说明

###### **Windows 用户注意事项**

对于 Windows 平台的用户，强烈建议使用 Git Bash 来执行本文档中的命令。原因如下：

1. **兼容性**：Git Bash 提供了类 Unix 的命令行环境，使得 Unix/Linux 风格的命令可以在 Windows 上顺利运行。
2. **一致性**：使用 Git Bash 可以确保命令行体验与其他平台（如 macOS 或 Linux）保持一致。
3. **功能完整性**：Git Bash 包含了许多常用的 Unix 工具和命令，这些在标准的 Windows 命令提示符中可能不可用。

###### 如何获取 Git Bash

如果您还没有安装 Git Bash，可以按照以下步骤进行安装：

1. 访问 Git 官方网站：https://git-scm.com/downloads
2. 下载适用于 Windows 的 Git 安装程序
3. 运行安装程序，确保在安装选项中选择安装 Git Bash

###### 其他平台用户

对于 macOS 和 Linux 用户，可以直接使用系统自带的终端应用程序执行本文档中的命令。

> 注意：在文档的后续部分，除非特别说明，所有命令均假定在 Git Bash（Windows）或标准终端（macOS/Linux）中执行。


#### 安装和配置

1. 安装 Git LFS 

```bash
# 前往 https://git-lfs.com 下载 git-lfs，然后安装 Git LFS
git lfs install
```

2. 安装 `gai`

```bash
# 下载并安装 gai
sudo /bin/bash -c "$(curl -fsSL https://gitee.com/gitee-ai/cli/raw/master/install.sh)"

# 检查 Gitee AI CLI 版本
gai version
```

3. 配置 `gai`
- 创建 Gitee 私人令牌：https://gitee.com/profile/personal_access_tokens ，创建令牌时请勾选 `projects` 权限
- 创建 Gitee AI 访问令牌，请参考帮助文档：https://ai.gitee.com/docs/organization/access-token ，创建时「资源授权」请选择「全部资源」
- 在 `gai` 中配置令牌
    ```bash
    # 全局配置 Gitee AI 和 Gitee 访问令牌
    gai config gitee-token <Gitee 私人令牌>
    gai config gitee-ai-token <Gitee AI 访问令牌>
    ```

如果希望为**不同仓库**设置不同令牌，可参考如下命令进行配置：

```bash
cd <仓库地址>

# 配置 Gitee 私人令牌
gai config --local gitee-token <Gitee 私人令牌>
# 配置 Gitee AI 访问令牌
gai config --local gitee-ai-token <Gitee AI 访问令牌>
```

#### 使用

将本地的大模型文件推送到 Gitee AI 模型仓库

1. 在 Gitee AI [创建模型仓库](https://ai.gitee.com/models/new)

2. 获取仓库地址并克隆到本地

    ![输入图片说明](assets/clone.png)

    ```bash
    git clone https://ai.gitee.com/<namespace>/<model>
    cd <model>
    ```

3. 初始化仓库配置（使用 `gai` 作为 Git LFS 的[自定义传输代理](https://github.com/git-lfs/git-lfs/blob/main/docs/custom-transfers.md)），每个仓库只需设置一次即可，相关配置将存储在仓库的 `.git/config` 文件中

    ```bash
    # 为本地仓库初始化 Gitee AI Cli 配置
    gai config init
    ```
    
4. 提交并推送文件到仓库

    ```bash
    # 拷贝大文件到当前目录并提交
    cp ~/<checkpoint_directory>/model.safetensors .
    git add . && git commit -m 'Add model.safetensors file'
    
    # 将更新推送到 Gitee AI 模型、数据集仓库
    git push origin master
    ```


#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)