ono-cli - 项目脚手架工具

一个简单易用的项目脚手架工具，帮助你快速创建项目，支持多种技术栈模板。

🚀 安装

npm install -g ono-cli

📖 使用指南

1. 配置脚手架

在使用脚手架前，需要先配置仓库源、组织和访问令牌：

交互式设置配置项：

ono-cli config -s

提示： 一般选择模板选择模式，如果选择依赖性选择模式，则需要将仓库中的模板名称改成与选项相对应的名称。

关于依赖性选择模式的说明

例如，如果你选择了react、ts、zustand、unocss等技术栈，那么你需要在仓库中创建一个名为 react-ts-zustand-unocss 的模板。

2. 创建项目

配置完成后，即可使用脚手架创建新项目：

ono-cli create [YOUR PROJECT NAME]

3. 查看配置

如果需要查看当前的配置信息，可以使用以下命令：

交互式查看配置项：

ono-cli config -g

4. 删除配置项

如果需要删除某个配置项，可以使用以下命令：

交互式删除配置项：

ono-cli config -d

5. 清空配置

如果需要清空所有配置，恢复到初始状态，可以使用以下命令：

ono-cli config -c

此命令将清空组织名称、访问令牌等所有配置项，使配置文件恢复到默认状态。

6. 更新脚手架

当有新版本时，可以使用以下命令更新：

ono-cli update [version]

如果不指定版本号，将自动更新到最新版本。

🔧 如何创建组织和访问令牌

GitHub

创建组织

1. 登录 GitHub 账户
2. 点击右上角的头像，选择 "Your organizations"
3. 点击 "New organization" 按钮
4. 选择组织类型（Free 或 Team）
5. 输入组织名称和联系方式
6. 点击 "Create an organization" 完成创建

创建访问令牌

1. 登录 GitHub 账户
2. 点击右上角的头像，选择 "Settings"
3. 在左侧边栏中，点击 "Developer settings"
4. 在 "Developer settings" 页面中，点击 "Personal access tokens" → "Tokens (classic)"
5. 点击 "Generate new token" 按钮
6. 输入令牌描述（Note）
7. 设置过期时间（Expiration）
8. 为令牌分配权限：
   • 对于访问私有仓库，至少需要 repo 权限
   • 如果要访问组织仓库，还需要 admin:org 或 read:org 权限
   • 如果访问的是私有仓库，还需要 read:org 权限
9. 点击 "Generate token" 按钮
10. 复制生成的令牌并妥善保存（一旦离开页面就无法再次查看）

Gitee

创建组织

1. 登录 Gitee 账户
2. 点击右上角的头像，选择 "组织"
3. 点击 "创建组织"
4. 输入组织名称、组织简介等信息
5. 选择组织类型（公开或私有）
6. 点击 "创建组织" 完成创建

创建访问令牌

1. 登录 Gitee 账户
2. 点击右上角的头像，选择 "设置"
3. 在左侧边栏中，点击 "私人令牌"
4. 点击 "生成新令牌" 按钮
5. 输入令牌名称和过期时间
6. 为令牌分配权限：
   • 对于访问仓库，需要选择 projects 权限
   • 对于访问组织信息，需要选择 organizations 权限
7. 点击 "生成令牌" 按钮
8. 复制生成的令牌并妥善保存（一旦离开页面就无法再次查看）

💡 模式说明

模板选择模式

• 直接从可用的模板列表中选择一个模板
• 适合对模板有明确选择的场景
• 可选择分支（branch）或标签（tag）进行克隆

依赖性选择模式

• 根据选择的技术栈自动匹配相应的模板
• 模板命名需要遵循特定规则（如 react-ts-zustand）
• 适合根据技术栈自动选择模板的场景

🔧 故障排除

如果遇到问题，请检查：

1. 确保已经正确配置了组织名称和访问令牌
2. 确保模板仓库名称与配置的组织匹配
3. 检查网络连接是否正常
4. 如果使用私有仓库，请确保访问令牌具有相应权限

📄 许可证

MIT