
Mirage Flow 保姆级 GitHub 使用教程从克隆仓库到 AI 集成你是不是刚接触 AI 开发写了一些基于 Mirage Flow 的代码想找个地方存起来还能和别人协作或者你听说过 GitHub但觉得那些命令行操作太复杂一直没敢上手别担心这篇文章就是为你准备的。我会用最直白的话带你从零开始一步步把代码放到 GitHub 上。你不需要有任何 Git 或 GitHub 的经验跟着做就行。我们会从注册账号开始讲到怎么创建仓库、上传代码最后还会聊聊怎么给你的 AI 项目写个漂亮的介绍甚至设置一些自动化任务。整个过程我都会用我们熟悉的 Mirage Flow 项目作为例子。学完这篇教程你就能轻松管理自己的代码再也不用担心代码丢失还能让更多人看到你的作品。1. 准备工作注册 GitHub 和安装 Git在开始上传代码之前我们得先把“工具”准备好。这就像你要寄快递得先有个快递站GitHub和打包工具Git。1.1 注册一个 GitHub 账号首先我们去 GitHub 的官网。在浏览器里输入github.com就能看到。打开网站后点击右上角的“Sign up”按钮。按照页面提示输入你的邮箱、设置一个密码再想一个用户名。用户名会显示在你的项目地址里比如https://github.com/你的用户名/你的项目名所以可以想个有特点的。完成邮箱验证等步骤你的账号就创建好了。整个过程和注册一个普通网站账号没什么区别。1.2 在电脑上安装 GitGit 是一个版本控制工具你可以把它理解成一个“时光机”或者“超级备份软件”。它能记录你每次对代码的修改让你可以随时回到之前的任何一个版本。GitHub 则是存放这些“备份”的云端仓库。我们需要在本地电脑安装 Git 客户端Windows 用户去 Git 官网下载安装程序一路点击“Next”即可。安装完成后在开始菜单里找到 “Git Bash”打开它我们后续的命令行操作都在这里面进行。Mac 用户通常系统已经自带了 Git。你可以打开“终端”Terminal输入git --version看看有没有版本号显示。如果没有会提示你安装跟着提示走就行。Linux 用户用包管理器安装比如 Ubuntu 用sudo apt install git。安装好后打开命令行工具Windows 用 Git BashMac/Linux 用终端输入以下命令设置你的身份信息这样你提交代码时GitHub 就知道是谁做的了。git config --global user.name 你的GitHub用户名 git config --global user.email 你注册GitHub的邮箱好了工具备齐我们可以正式开始“搬家”了。2. 创建你的第一个 GitHub 仓库仓库Repository简称 Repo就是你在 GitHub 上存放项目的地方。一个项目对应一个仓库。登录你的 GitHub 账号在页面右上角找到“”图标点击它然后选择“New repository”。你会进入创建仓库的页面需要填写一些信息Repository name: 给你的仓库起个名字。比如我们的 Mirage Flow 项目可以叫mirage-flow-demo。Description: 简单描述一下这个项目是干什么的。比如“一个基于 Mirage Flow 的 AI 应用示例”。Public / Private: 选择仓库是公开所有人可见还是私有仅自己可见。对于学习和小项目选 Public 没问题。Initialize this repository with: 这里我们先不要勾选“Add a README file”等选项。因为我们已经有本地代码了要用另一种方式关联。直接点击最下方的“Create repository”按钮。创建成功后你会看到一个快速设置页面。先别关我们马上会用到它提供的地址。3. 将本地 Mirage Flow 项目上传至 GitHub假设你的 Mirage Flow 项目代码已经在本地电脑的一个文件夹里了比如路径是D:\my_ai_project。3.1 初始化本地 Git 仓库打开命令行工具使用cd命令进入到你的项目文件夹。cd /d/my_ai_project # Windows 示例进入D盘的my_ai_project文件夹 # 或者 cd ~/Documents/my_ai_project Mac/Linux 示例然后在这个文件夹里初始化一个 Git 仓库git init这个命令会在你的项目文件夹里创建一个隐藏的.git文件夹它就是用来记录所有版本信息的“时光机核心”。3.2 添加文件到暂存区接着告诉 Git 哪些文件需要被管理。通常我们会添加所有文件git add .这个点.代表当前目录下的所有文件和子目录。执行后Git 就把这些文件的变化“暂存”起来了。3.3 提交更改到本地仓库把暂存的文件做一个正式的“存档”并附上一句说明git commit -m “首次提交添加Mirage Flow基础项目代码”-m后面的信息就是这次提交的说明尽量写清楚你做了什么这样以后回头看历史记录就一目了然。3.4 连接到远程 GitHub 仓库现在要把我们本地的“时光机”和 GitHub 上的“云端备份站”连接起来。回到刚才创建仓库后 GitHub 提供的那个页面找到类似这样的命令通常有两种我们选 SSH 或 HTTPS这里以 HTTPS 为例git remote add origin https://github.com/你的用户名/mirage-flow-demo.git把这条命令复制到你的命令行里执行。origin是给这个远程仓库起的一个别名通常就用这个。3.5 推送代码到 GitHub最后一步把本地提交的“存档”推送到 GitHubgit push -u origin main如果你是第一次推送可能会弹窗让你输入 GitHub 的用户名和密码密码部分现在一般用 Personal Access Token创建方法在 GitHub 设置里很简单按提示操作即可。-u参数表示把本地的main分支和远程的main分支关联起来下次你只需要输入git push就行了。刷新你的 GitHub 仓库页面恭喜你的 Mirage Flow 项目代码已经安然无恙地躺在云端了。4. 进阶技巧让仓库更专业代码传上去了但一个专业的仓库还需要一些“装修”和“自动化工具”。4.1 创建 .gitignore 文件这个文件特别重要它告诉 Git 哪些文件或文件夹不需要上传到仓库。比如 Python 的虚拟环境venv/、缓存文件__pycache__/、大型数据集、API密钥配置文件等。忽略它们可以让仓库更干净也保护了敏感信息。在你的项目根目录下新建一个名为.gitignore的文件注意前面有个点然后用文本编辑器打开添加需要忽略的内容。一个针对 Python/AI 项目的简单示例# Python __pycache__/ *.py[cod] *$py.class *.so .Python venv/ env/ .venv/ # IDE .vscode/ .idea/ *.swp *.swo # 日志与数据 *.log *.sqlite3 *.db data/ # 假设你的大型数据放在data文件夹里 # 特定文件 config.yaml # 假设这里面有你的API密钥 .DS_Store (Mac)保存后记得也要用git add .gitignore和git commit -m “add .gitignore”把它提交上去。4.2 编写一个清晰的 README.mdREADME.md 是你项目的“门面”别人点进来第一眼看到的就是它。用 Markdown 语法写非常简单。在项目根目录创建README.md文件可以包含以下部分# Mirage Flow 示例项目 这是一个基于 [Mirage Flow](https://github.com/mirage-flow/mirage-flow) 框架构建的 AI 对话应用示例。 ## 项目简介 本项目展示了如何使用 Mirage Flow 快速搭建一个具备记忆和工具调用能力的智能对话助手。 ## 快速开始 ### 环境要求 - Python 3.8 - 安装依赖pip install -r requirements.txt ### 运行项目 1. 克隆本仓库git clone https://github.com/你的用户名/mirage-flow-demo.git 2. 进入目录cd mirage-flow-demo 3. 安装依赖pip install -r requirements.txt 4. 运行应用python app.py ## 功能特性 - ✅ 多轮对话记忆 - ✅ 支持调用外部工具如天气查询、计算器 - ✅ 简单的Web界面 ## 项目结构mirage-flow-demo/ ├── app.py # 主应用文件 ├── requirements.txt # 依赖列表 ├── README.md # 本文件 └── .gitignore # Git忽略文件## 贡献 欢迎提交 Issue 和 Pull Request写好之后同样提交并推送到 GitHub。4.3 尝试使用 GitHub Actions 进行简单 CICI持续集成可以帮你自动完成一些任务比如每次推送代码后自动检查代码格式、运行测试。对于 AI 项目甚至可以自动重新训练模型。GitHub Actions 的配置文件放在.github/workflows/目录下。我们创建一个最简单的例子每次推送代码时自动检查 Python 语法使用black格式化检查。在项目根目录创建文件夹和文件.github/workflows/python-check.yml编辑这个 yml 文件name: Python Code Check on: [push] # 在推送代码时触发 jobs: lint: runs-on: ubuntu-latest steps: - uses: actions/checkoutv3 # 检出代码 - name: Set up Python uses: actions/setup-pythonv4 with: python-version: ‘3.9’ - name: Install dependencies run: | pip install black - name: Check formatting with black run: | black --check .提交这个工作流文件并推送。之后你每次推送代码在 GitHub 仓库的 “Actions” 标签页下就能看到自动运行的任务了。如果代码格式不符合black规范任务会失败并提示你。这只是一个开始GitHub Actions 能做的事情非常多你可以根据需要慢慢探索。5. 总结走完这一趟你应该已经成功地把本地的 Mirage Flow 项目托管到了 GitHub。从注册安装到提交推送再到用.gitignore保持仓库整洁用README.md展示项目甚至触碰了一点自动化的边。整个过程看起来步骤不少但核心就是几个命令init,add,commit,push。多操作几次肌肉记忆就形成了。Git 和 GitHub 是开发者最基础也最重要的协作工具。把它用起来你的代码就有了一个安全的家项目的可维护性和可协作性也大大提升。下次当你对 Mirage Flow 项目有新的改进时记得add-commit-push三步走养成随时备份和记录的好习惯。获取更多AI镜像想探索更多AI镜像和应用场景访问 CSDN星图镜像广场提供丰富的预置镜像覆盖大模型推理、图像生成、视频生成、模型微调等多个领域支持一键部署。