Comment on page
Setting up your developer environment
Please refer to our installation docs for instructions on how to install Docker and Kubernetes for different platforms.
git clone https://github.com/garden-io/garden.git
For Mac we have a script that installs all required dependencies.
./scripts/install-osx-dependencies.sh
Other platforms need to roll their own for now (contributions welcome!). Please have a look at the script for OSX to see what's installed.
If you have LinuxBrew installed, install-osx-dependencies.sh should work if you run it, although you will have to ensure that you've added NPM to your PATH via
.bashrc
.zshrc
or other shell run command script.If you are an asdf user, running install-asdf-dependencies.sh in order to automatically install the correct plugins and versions as defined in
.tool-versions
.Install Node modules for the root package, and
core
package:yarn install # To install root dependencies
yarn run bootstrap # To bootstrap packages
from the root directory
cd core
yarn
Before running Garden for the first time, you need to do an initial build by running
yarn build
from the root directory.
To develop the CLI, run the
dev
command in your console:yarn dev
This will link it to your global
node_modules
folder, and then watch for changes and auto-rebuild as you code. You can then run the garden
command as normal.Also, you might like to add a couple of shorthands:
alias g='garden'
alias k='kubectl'