Installation and the Zendro CLI
Every Zendro project, whether you set it up with the Quickstart shortcut or the full Getting started walkthrough, starts from the same CLI installation. This page covers that shared groundwork, plus updating and uninstalling Zendro, so the other guides can just link back here instead of repeating it.
Table of contents
Requirements
- NodeJS version 18+ is required.
- docker and the docker compose plugin (if not already included in your docker installation) are recommended for setting up Zendro.
We strongly recommend following this guide to use docker without sudo.
Recommendations
- We strongly recommend using Zendro on Linux, with or without docker.
- On Windows, we recommend using Zendro through the Windows Subsystem for Linux (WSL). However, inside WSL consider operating on native paths, not the mounted windows. There is high IO latency otherwise.
- On Mac, we recommend using Zendro without docker.
Install the Zendro CLI
npm install -g git+https://github.com/Zendro-dev/zendro.git
The zendro command is now available anywhere on your system. See the CLI reference for the full list of commands, or continue to the Quickstart or Getting started guide to create your first project.
If you’d rather work from a local, editable checkout (e.g. to contribute to the CLI itself), clone and link it instead:
git clone https://github.com/Zendro-dev/zendro.git
cd zendro
npm install
npm link
Updating Zendro
If you installed with npm install -g git+..., just run that same command again — a global install has no lockfile pinning it to the commit you started with, so it always re-resolves and picks up the latest changes:
npm install -g git+https://github.com/Zendro-dev/zendro.git
If you used the local git clone + npm link method instead, pull the latest changes and refresh the CLI’s own git-based dependencies. Unlike the CLI’s own code, these three are pinned by your local package-lock.json, so a plain npm install alone won’t move them past the commit they were first resolved at — npm update re-resolves them properly:
git pull
npm update graphql-server-model-codegen zendro-bulk-create ZendroStarterPack
Uninstallation
Remove a project
zendro rm <name>
This deletes the project’s directory along with its docker containers, images and volumes. Add -f/--force to skip the confirmation prompt.
Uninstall the Zendro CLI
If installed via npm install -g:
npm uninstall -g zendro
If installed via the local git clone + npm link method:
npm unlink -g zendro
rm -r "path/to/zendro"