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).
- On Mac, we recommend using Zendro without docker.
Install the Zendro CLI
$ git clone https://github.com/Zendro-dev/zendro.git
$ cd zendro
$ npm install
$ sudo npm link
In Windows Subsystem for Linux, sudo npm may not work; try sudo -E env "PATH=$PATH" npm instead. The same applies to the docker-related command zendro dockerize, since docker requires elevated permissions.
Once linked, the zendro command is 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.
Updating Zendro
To update the Zendro CLI itself, go to your zendro folder and run:
$ git pull
$ rm -r package-lock.json node_modules
$ npm install
Uninstallation
Remove a project
$ sudo rm -r "path/to/<name>"
$ docker rmi -f $(docker images -a -q "<name>*")
$ docker volume rm $(docker volume ls -q | grep "^<name>")
Uninstall the Zendro CLI
$ sudo npm unlink -g zendro
$ sudo rm -r "path/to/zendro"