Install the CLI
Install the Tilizy CLI with the command from your profile, confirm that it works on your computer and keep it up to date.
On this page
The Tilizy CLI is one command-line program, tilizy, for everything around your website: running it on your own computer, copying data, deploying and rolling back. It is included in every Tilizy Hosting plan. You do not need it to deploy, because deploys happen when you push to Git. This page covers what the CLI needs, how to install it, how to check that it works and how to keep it up to date.
What you need
| Requirement | Needed for |
|---|---|
| A Tilizy account with access to your project | Everything that talks to the portal or to a hosted environment |
| Git | The CLI finds your project from the Git remote of your checkout |
| Docker, installed and running | Running your website on your own computer |
mkcert, set up once with mkcert -install | The https address of your local website |
The CLI never installs Docker or mkcert for you, and it never changes which certificates your computer trusts. It tells you what is missing and stops.
Install
You get the install command from your own account. It carries a token that only installs the CLI: it cannot deploy and it cannot read anything.
-
Sign in at app.tilizy.com, open your profile and go to Devices.
-
Under Install the CLI, press Get the install command and copy the command it shows. It is valid for 15 minutes.
-
Paste it into a terminal on the computer you work on. It has this form, with your own token at the end:
curl -fsSL https://app.tilizy.com/install | sh -s -- --token YOUR_TOKEN
The installer works on macOS and Linux, on Intel or AMD and on ARM processors. It downloads the program for your system, verifies its checksum and puts it at ~/.local/bin/tilizy. If your shell does not find tilizy afterwards, add ~/.local/bin to your PATH.
| Option | What it does |
|---|---|
--token <token> | The install token from your profile. Needed for the first install only. |
--version <number> | Installs one specific version instead of the latest. |
--bin <path> | Installs to another place than ~/.local/bin/tilizy. |
Note: The installer is a plain script. You can read it at app.tilizy.com/install before you run it.
Check the installation
-
Confirm that the program is found. The command prints the version number:
tilizy --version -
Sign in. See Sign in and choose a project:
tilizy auth:login -
Check your account and your computer. The command lists what is still outstanding: Docker,
mkcert, your sign-in, and the checkout you are standing in:tilizy cli:setup -
Optionally, let the CLI walk through the open steps with you. It asks before each step it runs:
tilizy cli:setup --setup
When your website runs locally and something looks wrong, a second check looks at the local application, Docker, the certificates and your access:
tilizy app:doctor
Keep it up to date
See whether a newer version exists, without installing anything:
tilizy cli:update --check
Update to the latest version:
tilizy cli:update
The command downloads the new version over your sign-in, verifies its published checksum and then replaces the program in one step. If you are already on the latest version, it does nothing.
| Option | What it does |
|---|---|
--check | Reports the installed and the latest version, and installs nothing. |
--version <number> | Installs one specific version instead of the latest. |
--force | Installs again even when you are already on that version. |
Shell completion
The CLI can complete commands and options when you press Tab. Generate the script for your shell: bash, zsh, fish or powershell.
tilizy cli:completion zsh
The command prints the script. tilizy cli:completion zsh --help explains how to load it in that shell.
Jump between projects
If you work on several projects, add the shell hook once. It lets tilizy project:go <name> change your shell into the checkout of a project. It works in zsh and bash.
echo 'eval "$(tilizy cli:shell-init)"' >> ~/.zshrc
Find your way around
Every command explains itself. --help shows its arguments, its options, and whether it acts on your computer or on a hosted environment.
tilizy --help
tilizy help app
tilizy app:deploy --help
The first shows the groups of commands, the second the commands of one group, the third one command in full.
What can go wrong
- The update is refused.
cli:updateuses your sign-in. Runtilizy auth:loginfirst. - A command waits for input in a script. Add
--no-input, or setTILIZY_NO_INPUT=1. The CLI then never asks: it skips optional questions and stops with a clear message when a required value is missing. - The local website does not start. Docker is not running, or
mkcertis not set up.tilizy cli:setupnames what is missing.
Next: Sign in and choose a project, then run your website locally.