Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.42 KB

README.md

File metadata and controls

28 lines (21 loc) · 1.42 KB
Raw

mkprj

mkprj is a simple cli utility to make project creation more seamless. It allows you to create a project with most language's templates and then open it in your favorite editor. The primary purpose of this tool is to unify template bootstrapping to one command.

This project seems pointless

It is, to be honest. But, I find the commands ran just to start a new project are enough of a point of friction (for me) to warrant a tool like this. I hope you find it useful too.

Supported npm alternatives

  • npm (obviously)
  • yarn
  • deno
  • bun

Installation

cargo install --git https://github.com/Morgandri1/mkprj

Configuration

mkprj uses a json config file which you can easily interact with using the mkprj config command. The default config file is located at ~/.mkprj/config.json.

The options are as follows:

  • --editor_command: The editor to open the project in. This can be any command that opens a file in your editor. The default is vim.
  • --node_command: Your javascript/node command. The default is npm, but you can change it to any one of bun, yarn, deno.

Usage

mkprj is a fairly simple app to use. Simply run mkprj <project_name> --<language> to create a project. For example, to create a rust project, you would run mkprj my_project --rust. But, if you don't want to use a language template, you can simply run mkprj my_project and it will create a project with a git repository.