[go: nahoru, domu]

Skip to content

CaoMeiYouRen/cmyr-template-cli

Repository files navigation

cmyr-template-cli

Version GitHub Workflow Status Documentation Maintenance License: MIT

草梅友仁自制的项目模板创建器

🏠 主页

https://github.com/CaoMeiYouRen/cmyr-template-cli#readme

Demo

https://github.com/CaoMeiYouRen/cmyr-template-cli#readme

依赖要求

  • node >=12

安装

npm i -g cmyr-template-cli

# 或者 yarn global cmyr-template-cli
# 或者 pnpm i -g cmyr-template-cli

使用

ct
#
ct create

配置

在当前目录下或 HOME 路径下创建 .ctrc 文件即可,格式为 json

{
    "GITHUB_TOKEN": "",
    "GITEE_TOKEN": "",
    "GITHUB_USERNAME": "",
    "GITEE_USERNAME": "",
    "AFDIAN_USERNAME": "",
    "PATREON_USERNAME": "",
    "WEIBO_USERNAME": "",
    "TWITTER_USERNAME": "",
    "NPM_USERNAME": "",
    "DOCKER_USERNAME": ""
}

GITHUB_TOKEN:可空,默认值为空。请参考: 创建用于命令行的个人访问令牌

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 的用户名

如果不使用自动初始化远程仓库功能,可以跳过该配置

开发

npm run dev

编译

npm run build

Lint

npm run lint

Commit

npm run commit

作者

👤 CaoMeiYouRen

🤝贡献

欢迎 贡献、提问或提出新功能!
如有问题请查看 issues page.
贡献或提出新功能可以查看contributing guide.

💰支持

如果觉得这个项目有用的话请给一颗⭐️,非常感谢

📝 License

Copyright © 2021 CaoMeiYouRen.
This project is MIT licensed.


This README was generated with ❤️ by cmyr-template-cli