Installing Garden
Last updated
Was this helpful?
Bonsai (0.13)
Last updated
Was this helpful?
This page details the different installation methods for Garden.
Please follow the guide for your operating system:
If you'd like to run Kubernetes locally, please see our for installation and usage information.
If you want to install Garden from source, see the instructions in our .
You need the following dependencies on your local machine to use Garden:
Git (v2.14 or newer)
[Windows only] rsync (v3.1.0 or newer)
And if you'd like to build and run services locally, you need . Garden is committed to supporting . The information on the Kubernetes support and EOL timelines can be found .
For Mac, we recommend the following steps to install Garden. You can also follow the manual installation steps below if you prefer.
To later upgrade to the newest version, simply run brew update and then brew upgrade garden-cli.
To later upgrade to the latest version, simply run the script again.
If you prefer, you can perform the installation manually, as follows:
Next create a ~/.garden/bin directory, and extract the archive to that directory. Make sure to include the whole contents of the archive.
Lastly, either add the ~/.garden/bin directory to your PATH, or add a symlink from your /usr/local/bin/garden to the binary at ~/.garden/bin/garden.
To install Docker, Kubernetes and kubectl, we recommend Docker for Mac.
You can run Garden on Windows 10 or later.
To install the Garden CLI and its dependencies, please use our installation script. To run the script, open PowerShell as an administrator and run:
The things the script will check for are the following:
git and rsync . The script will install or upgrade those via Chocolatey.
To later upgrade to the newest version, simply re-run the above script.
We also recommend adding an exclusion folder for the .garden directory in your repository root to Windows Defender:
This will significantly speed up the first Garden build of large projects on Windows machines.
Note that you must run Powershell with elevated permissions when you execute this command.
Use your preferred method or package manager to install git and rsync. On Ubuntu, that's sudo apt install git rsync, on Alpine apk add --no-cache git rsync
The Alpine linux distribution also requires gcc to be installed: apk add --no-cache gcc.
You can use our installation script to install Garden automatically:
To later upgrade to the latest version, simply run the script again.
If you prefer, you can perform the installation manually, as follows:
Next create a ~/.garden/bin directory, and extract the archive to that directory. Make sure to include the whole contents of the archive.
Lastly, either add the ~/.garden/bin directory to your PATH, or add a symlink from your /usr/local/bin/garden to the binary at ~/.garden/bin/garden.
If you're running Garden behind a firewall, you may need to use a proxy to route external requests. To do this, you need to set the HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables. For example:
The NO_PROXY variable should include any other hostnames you might use for local development, since you likely don't want to route local traffic through the proxy.
Once you've installed Garden, you can update it with the Garden self-update command like so:
To install Garden at a specific version, say 0.13.22, you can run:
To install the latest edge release of Garden you can run:
You can learn more about the different options by running:
If you haven't already set up Homebrew, please follow .
You can easily install Garden using or using our installation script. You may also manually download Garden from the on GitHub.
First make sure the listed above are installed. Then run our automated installation script:
Make sure the listed above are installed.
Visit the Garden on GitHub and download the macOS archive (under Assets).
Please refer to their for how to download and install it (which is a pretty simple process).
If you'd like to use a local Kubernetes cluster, please refer to the for further information. For remote clusters, take a look at the .
Note: Building docker images generally requires installing Docker Desktop. Please refer to .
The package manager. The script installs it automatically if necessary.
Visit the Garden on GitHub and download the linux archive (under Assets).
If you'd like to use a local Kubernetes cluster, please refer to the for installation and usage information.