kmnd
v0.1.1
Published
![Module type: ESM](https://img.shields.io/badge/module%20type-esm-brightgreen) ![CI Status](https://github.com/palladians/kmnd/actions/workflows/ci.yml/badge.svg) [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/palladians_xyz.svg?style=s
Downloads
2
Readme
kmnd
Your terminal's missing command palette.
Why?
- You won't have to look for you app's scripts in
package.json
again. Just hitkmnd
and select the command to run. - You forgot to install commitzen for conventional commits again? Don't worry, we got you covered with
Git -> Commit
. - You won't have to search for the commands to create Next, Remix, Vite, and CRA apps again. Want more boilerplates? Let us know.
Features
- [x] Read closest
package.json
for itsscripts
. - [x] Read annotations for
scripts
. - [x] Filter commands with text input.
- [x] Conventional commit command.
- [x] Create app from boilerplates (Next.js, Remix, Vite).
- [ ] Tools for other ecosystems than TypeScript.
- [ ] Persistent settings with
~/.kmnd
. - [ ] Custom commands and local automation with
~/.kmnd
. - [ ] Interface for community extensions.
Usage
In this section we've covered how to install and use kmnd
. You can either run it once with npx
to check if it suits you, or install globally if you want to stay with it.
Test without installing globally
$ npx kmnd@latest
Install
npm i -g kmnd@latest
Run
kmnd
Btw, you can add alias to your .zshrc
or .bashrc
to make it even shorter. Here you go: alias k="kmnd"
Development
Prerequisite
- NVM
- PNPM
Prepare
$ nvm use
$ pnpm i
Build
$ pnpm build
Run unit tests
$ pnpm test:unit
Contributors
Made with contrib.rocks.
Maintained by
Acknowledgements
- Shout out to Vadim Demedes for creating
ink
andink-ui
.