Skip to content

Ardanas/quick-starter

Repository files navigation

⚡️ quick starter

npx quick-starter

Features

  • ✨ Manage your templates via configuration files
  • ✨ Support cloning templates from locally.
  • ✨ Support pulling templates from popular git providers.
  • More

Usage(CLI)

quick-starter [template] [dir] [...options]

Arguments

  • template:
    • Template name or a URI describing provider, repository, sub dir, and branch/ref. (See Examples)
    • from your config
  • dir: A relative or absolute path where to extract the template. By default, it is the current directory.

Options

-d, --dir: A relative or absolute path where to extract the template, with the highest priority.

-c, --config: Temporarily configure your template file, but do not modify the default configuration file.

-f, --force: Clone and overwrite an existing directory.

More options

Examples

1. Clone the template from your template configuration file

⚡  npx quick-starter

If you haven't set up your template configuration file yet, we provide a default template configuration

2. Clone the template locally to the specified location

npx quick-starter ./dir/filename ./

3. Clone the template remotely to the specified location

npx quick-starter gh:antfu/starter-ts ./

Manage your templates

1. Overwrite default template configuration

npx quick-starter config set ../filePath

2. Edit template configuration

npx quick-starter config edit

After executing the command, it will enter vi editing mode

3. View the current template configuration

npx quick-starter config list

Alternatives

License

MIT License © 2024 Ardanas