Skip to content

实现 mirror，添加 help #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shigma merged 5 commits into from
Dec 25, 2025
Merged

实现 mirror，添加 help #13

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5bf7e1e
feat: add support for custom npm registry mirror
MirrorCY Dec 19, 2025
0205519
feat: add help option
MirrorCY Dec 19, 2025
0b547c8
Update packages/create/src/index.ts
MirrorCY Dec 19, 2025
0df45e8
feat: replace mirror option with registry
MirrorCY Dec 21, 2025
366d35d
Update packages/create/src/index.ts
shigma Dec 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions packages/create/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ const argv = parse(process.argv.slice(2), {
ref: ['r'],
forced: ['f'],
git: ['g'],
mirror: ['m'],
prod: ['p'],
template: ['t'],
yes: ['y'],
help: ['h'],
},
})

Expand Down Expand Up @@ -90,7 +90,8 @@ async function prepare() {
async function scaffold() {
console.log(kleur.dim(' Scaffolding project in ') + project + kleur.dim(' ...'))

const registry = (await getRegistry()).replace(/\/$/, '')
const registry = (argv.registry || await getRegistry() || 'https://registry.npmjs.org').replace(/\/$/, '')
console.log(kleur.dim(` Using registry: ${registry}\n`))
const template = argv.template || '@koishijs/boilerplate'

try {
Expand Down Expand Up @@ -168,6 +169,23 @@ async function install() {
}

async function start() {
if (argv.help) {
console.log(`
Usage: create-koishi [name] [options]

Options:
-t, --template <name> Template to use (default: @koishijs/boilerplate)
-r, --ref <ref> Reference to use (default: latest)
-f, --forced Force overwrite target directory
-g, --git Initialize git repository
--registry <url> Use specific registry (e.g., https://registry.npmmirror.com)
-p, --prod Production mode
-y, --yes Skip prompts
-h, --help Show this help message
`)
return
}

console.log()
console.log(` ${kleur.bold('Create Koishi')} ${kleur.blue(`v${version}`)}`)
console.log()
Expand Down