@casthub/devon

Docker-based Monorepo Local Development CLI

This is a work-in-progress!

@casthub/devon is a node-based CLI tool aiming to bridge the gap between production and local development for monorepos.

• Configure multi-command Scripts for common development workflows
• Automate trusted local SSL certificates out-of-the-box
• Generate .env files automatically based on the target environment
• Run production-grade images locally without having to touch docker commands
• Bootstrap existing Monorepos with intelligent initialization
• TypeScript definitions/configs

Installation

This package is available via NPM:

yarn global add @casthub/devon

# or

npm install -g @casthub/devon

You also need to have Docker installed on your local machine. It can be downloaded via docker.com.

If you want devon to automate generating and installing local SSL Certificates, you also must install mkcert.

Usage

devon help lists all available commands and usage. Some useful commands to get you started are:

• devon init - Initialize devon in the current working directory. This should be the root of your monorepo.
• devon install - Should be ran every time a new device clones the repo. Does things like install the certificate CA, etc.
• devon switch - Switch which services/apps you are currently working on.
• devon run <name...> - Run the given Script(s).
• devon exec <name> <command...> - Run a command inside the container for a service.

To-do

• Add test suite

Changelog

1.0.7 (2021-08-05)

• Export command logic for programmatic use
• Added down command