https://github.com/evilkiwi/devon
Docker-based Monorepo Local Development CLI
https://github.com/evilkiwi/devon
cli dev docker environment local monorepo
Last synced: about 1 year ago
JSON representation
Docker-based Monorepo Local Development CLI
- Host: GitHub
- URL: https://github.com/evilkiwi/devon
- Owner: evilkiwi
- License: gpl-3.0
- Created: 2021-08-04T10:57:34.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T12:26:29.000Z (over 3 years ago)
- Last Synced: 2025-03-25T07:04:28.526Z (over 1 year ago)
- Topics: cli, dev, docker, environment, local, monorepo
- Language: TypeScript
- Homepage: https://docs.evil.kiwi/devon/
- Size: 1.27 MB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Docker-based Monorepo Local Development CLI
`@evilkiwi/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:
```bash
yarn global add @evilkiwi/devon
# or
npm install -g @evilkiwi/devon
```
**You also need to have Docker installed on your local machine.** It can be downloaded via [docker.com](https://www.docker.com/products/docker-desktop).
If you want `devon` to automate generating and installing local SSL Certificates, you also must [install mkcert](https://github.com/FiloSottile/mkcert#installation).
## Documentation
You can view the [online documentation here](https://docs.evil.kiwi/devon/).
## 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 ` - Run the given Script(s).
- `devon exec ` - Run a command inside the container for a service.
## To-do
- [ ] Add test suite