https://github.com/caomeiyouren/cmyr-template-cli
草梅友仁自制的项目模板创建器
https://github.com/caomeiyouren/cmyr-template-cli
creator project-creator template-creator
Last synced: 4 months ago
JSON representation
草梅友仁自制的项目模板创建器
- Host: GitHub
- URL: https://github.com/caomeiyouren/cmyr-template-cli
- Owner: CaoMeiYouRen
- License: mit
- Created: 2021-09-20T10:52:41.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-06-30T07:32:10.000Z (about 1 year ago)
- Last Synced: 2025-06-30T08:38:48.494Z (about 1 year ago)
- Topics: creator, project-creator, template-creator
- Language: TypeScript
- Homepage:
- Size: 881 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
cmyr-template-cli
> 草梅友仁自制的项目模板创建器
### 🏠 [主页](https://github.com/CaoMeiYouRen/cmyr-template-cli#readme)
[https://github.com/CaoMeiYouRen/cmyr-template-cli#readme](https://github.com/CaoMeiYouRen/cmyr-template-cli#readme)
### ✨ [Demo](https://github.com/CaoMeiYouRen/cmyr-template-cli#readme)
[https://github.com/CaoMeiYouRen/cmyr-template-cli#readme](https://github.com/CaoMeiYouRen/cmyr-template-cli#readme)
## 依赖要求
- node >=18
## 安装
```sh
npm i -g cmyr-template-cli
# 或者 yarn global cmyr-template-cli
# 或者 pnpm i -g cmyr-template-cli
```
## 使用
```sh
ct
# 或
ct create
```
## 配置
在当前目录下或 `HOME` 路径下创建 `.ctrc` 文件即可，格式为 `json`
```json
{
"GITHUB_TOKEN": "",
"GITEE_TOKEN": "",
"GITHUB_USERNAME": "",
"GITEE_USERNAME": "",
"AFDIAN_USERNAME": "",
"PATREON_USERNAME": "",
"WEIBO_USERNAME": "",
"TWITTER_USERNAME": "",
"NPM_USERNAME": "",
"DOCKER_USERNAME": "",
"DOCKER_PASSWORD": "",
"CONTACT_EMAIL": "",
"NPM_TOKEN": ""
}
```
GITHUB_TOKEN：可空，默认值为空。请参考： [创建用于命令行的个人访问令牌](https://help.github.com/cn/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)
GITEE_TOKEN：可空，默认值为空。请参考：[私人令牌](https://gitee.com/profile/personal_access_tokens)
GITHUB_USERNAME：GitHub 用户名，可空，默认会使用 `git config user.name` 的用户名
GITEE_USERNAME：码云用户名，可空，默认值为空
AFDIAN_USERNAME：爱发电用户名，可空，默认值为空
PATREON_USERNAME：Patreon 用户名，可空，默认值为空
WEIBO_USERNAME：微博用户名，可空，默认值为空
TWITTER_USERNAME：Twitter 用户名，可空，默认值为空
NPM_USERNAME：Npm 用户名，可空，默认会使用 `GITHUB_USERNAME` 的用户名
DOCKER_USERNAME：Docker Hub 用户名，可空，默认会使用**小写的** `GITHUB_USERNAME` 的用户名
DOCKER_PASSWORD：Docker Hub 密码，可空，默认值为空。如果填写，会自动初始化对应的仓库 action secret
CONTACT_EMAIL：联系邮箱，可空，默认值为空
NPM_TOKEN：Npm 令牌，可空，默认值为空。如果填写，会自动初始化对应的仓库 action secret
**如果不使用自动初始化远程仓库功能，可以跳过该配置**
## 开发
```sh
npm run dev
```
## 编译
```sh
npm run build
```
## Lint
```sh
npm run lint
```
## Commit
```sh
npm run commit
```
## 作者
👤 **CaoMeiYouRen**
- Website: [https://blog.cmyr.ltd/](https://blog.cmyr.ltd/)
- GitHub: [@CaoMeiYouRen](https://github.com/CaoMeiYouRen)
## 🤝 贡献
欢迎 贡献、提问或提出新功能！
如有问题请查看 [issues page](https://github.com/CaoMeiYouRen/cmyr-template-cli/issues).
贡献或提出新功能可以查看[contributing guide](https://github.com/CaoMeiYouRen/cmyr-template-cli/blob/master/CONTRIBUTING.md).
## 💰 支持
如果觉得这个项目有用的话请给一颗 ⭐️，非常感谢
## 📝 License
Copyright © 2021 [CaoMeiYouRen](https://github.com/CaoMeiYouRen).
This project is [MIT](https://github.com/CaoMeiYouRen/cmyr-template-cli/blob/master/LICENSE) licensed.
---
_This README was generated with ❤️ by [cmyr-template-cli](https://github.com/CaoMeiYouRen/cmyr-template-cli)_