Velkit is a CLI tool that lets you clone repositories faster and comes with some additinional features such as E.P.A
You can use Velkit in two ways: with a single-line command or with a graphical user interface (GUI).
| Global Flag | Description |
|---|---|
--d, --debug |
Enable debug mode |
--gp, --global-proxy |
Globally sets the given proxy |
To clone a repository with a single-line command, use the following syntax:
npx velkit@latest clone <SOURCE> <DESTINATION> [FLAGS]For example, to clone typescript-starter repository from ProxityStudios into a directory named myapp, run:
npx velkit@latest clone ProxityStudios/typescript-starter myapp<> Required | [] Optional
| Flag | Referance | Accepted Values | Default Value | Description |
|---|---|---|---|---|
--upd, --update-package |
false |
Update package name and version | ||
--i, --install-deps |
<packageManager> |
npm, pnpm, bun, yarn |
do-not-install |
Install dependencies automatically |
TODO:
npx velkit@latest guiE.P.A stands for ESLint, Prettier, and Airbnb. These are popular tools for code formatting and quality. Velkit can install and configure them for you with a single command. Yeah, it's that simple.
If you're using TypeScript, you need to provide the --ts flag:
npx velkit@latest init-epa <path/to/install> --tsIf you're using JavaScript, you don't need to do anything extra, just omit the --ts flag.
npx velkit@latest init-epa <path/to/install>| Flag | Description |
|---|---|
--typescript, --ts |
Use TypeScript |
If you have any questions, issues, or feedback related to Velkit, create an issue through Github Issues!