ndom91 / rakun-js

Rakun CLI

Rakun 🦝

Experimental js cli for managing my local development environment

Getting Started 🚀

You can either download the latest release from the releases tab, or install the repo via npm.

$ npm install -g https://github.com/ndom91/rakun.js

Once installed, the cli can be used via the common pattern of rakun [FLAGS] [ACTION], like the following examples.

$ rakun --help
$ rakun restart
$ rakun -m -h ndo-docker status

Tip: After building the project, run npm link in the root of the repo to link the rakun binary to a directory in your systems $PATH so you can use the command rakun anywhere.

Options 🕹️

  FLAGS:
    -m [BOOL]          use docker-machine
    -h [STRING]        docker-machine hostname
    -cd                checkly directory

  ACTIONS:
    help, -h           display this help output
    status, -s         show current status of tmux window and containers
    start              start all development processes
      frontend, -f     start frontend only
      backend, -b      start backend only
      containers, -c   start containers only
      datapipeline, -d start data-pipeline only
    restart            restart running development processes
      frontend, -f     restart frontend only
      backend, -b      restart backend only
      containers, -c   restart containers only
      datapipeline, -d restart data-pipeline only
    stop               stop and kill any running processes
      frontend, -f     stop frontend only
      backend, -b      stop backend only
      containers, -c   stop containers only
      datapipeline, -d stop data-pipeline only

    clean            ensure no development processes or containers are left running

Contributing 🫠

Please stick to any formatting settings and if you have question or comments you can open an issue here.

License 📜

MIT