Find the Tilizy CLI command for a task, by group, with one line for each command.
Commands of the Tilizy CLI are written as tilizy <group>:<command>. This page lists the groups you use when your website is on Tilizy Hosting, with the commands in each. The CLI itself is always the most exact reference: every command explains its arguments, its options and the environment it acts on when you add --help.
Help in the terminal
| Command | Shows |
tilizy --help | The groups of commands |
tilizy help app | The commands of one group, here app |
tilizy help --all | Every command |
tilizy app:deploy --help | One command in full, with its scope |
tilizy --version | The installed version |
Command groups
| Group | What it is for |
cli:* | Set up, update and integrate the CLI with your shell. |
auth:* | Sign in, inspect your session or sign out. |
project:* | Find, fetch and link project checkouts. |
app:* | Configure, run and manage environments: start, deploy, roll back, read logs. |
service:* | Declare the database, cache and search services, and connect to them. |
db:* | Dump, load, copy and connect to databases. |
files:* | Inspect and transfer the files in your persistent folders. |
snapshot:* | Save and restore checkpoints of your local database. |
backup:* | Create, list and restore backups of an environment. |
var:* | Manage environment variables and secrets. |
domain:* | Manage the domains of your website. |
activity:* | See recent deploys, backups and other jobs of a project. |
dev:* | Run the checks of your project, fix code, debug and watch for changes. |
security:* | Check the declaration of personal data in your project. |
addon:* | List and manage the command sets for frameworks. |
| Your framework | drupal:*, laravel:*, wordpress:* or prestashop:*, depending on the framework key of your project file. These appear only inside a checkout. |
Flags that work on most commands
| Flag | Meaning |
-p <project> | The project, by its short name. Without it, the CLI matches the Git remote of the checkout you are in. It never guesses. |
-e <branch> | The hosted environment of that branch. -e local is the copy on your computer. |
--staging | The staging environment. |
--prod | The live environment. |
--no-input | Never ask a question: skip optional ones and stop when a required value is missing. For scripts. The variable TILIZY_NO_INPUT=1 does the same. |
--help | Explain the command. |
Commands that work locally act on the copy on your computer when you give no environment flag. Commands that work only on hosted environments act on live. See Sign in and choose a project.
cli and auth
| Command | What it does |
cli:setup | Checks that your account and your computer are ready. --setup walks through the open steps. |
cli:update | Updates the CLI. --check only compares versions. |
cli:completion | Prints the completion script for bash, zsh, fish or powershell. |
cli:shell-init | Prints the shell hook that project:go needs. |
auth:login | Signs in through your browser. Short form: login. |
auth:info | Shows the signed-in user and the portal. Short form: whoami. |
auth:logout | Forgets the sign-in on this computer. --revoke also ends it at the portal. |
auth:token | Signs in with a token, for scripts. |
project
| Command | What it does |
project:list | Lists the projects you can open and marks the ones checked out on this computer. --local lists only those, without contacting the portal. |
project:info | Shows the details of a project and the environment variables it expects. |
project:setup <project> | Clones a project and starts it locally. --data also copies the database and the files. |
project:link <project> | Binds the Git remote of the current checkout to a project. |
project:go [name] | Changes your shell into the checkout of a project. Needs the shell hook. |
project:edit [name] | Opens the checkout of a project in your editor. |
app
| Command | What it does | Without a flag, acts on |
app:init | Writes a first .tilizy/app.yaml for the checkout. | Your checkout |
app:validate | Checks the files in .tilizy/. | Your checkout |
app:start | Starts the local website, or resumes a paused hosted environment with -e. | Local |
app:stop | Stops the local website, or pauses a hosted environment with -e. --purge also deletes the local data. | Local |
app:restart | Rebuilds and restarts the local website. | Local |
app:poweroff | Stops every local website on this computer. | Local |
app:status | Shows the state of an environment. | Local |
app:logs [service] | Shows the logs. -f follows them. | Local |
app:shell | Opens a shell in an environment. | Local |
app:open | Opens an environment in the browser. --print prints the address. | Local |
app:mail | Opens the local mail inbox. | Local |
app:doctor | Checks the local website, Docker, the certificates and your access. | Local |
app:build | Runs the build hooks of the project file. | Local |
app:composer | Runs Composer. | Local |
app:php | Runs PHP. | Local |
app:exec | Runs a command in the local website. --build runs it where the code is writable. | Local |
app:launch | The first deploy: creates the live environment of a project. | Live |
app:deploy | Deploys an environment. | Live |
app:rollback | Returns an environment to an earlier release. --list shows the choices. | Live |
app:create | Creates an environment from a branch and fills it from live. Needs -e <branch>. | Needs -e |
app:sync | Copies the database and the files of live into another environment. Needs -e <branch>. | Needs -e |
app:destroy | Removes an environment and its data for good. Refuses live. | Needs -e |
Short forms: init, validate, start, stop, restart, status, logs, shell, open, doctor, build, composer, php, exec, deploy and rollback.
service
| Command | What it does |
service:add <type> [name] | Adds a service to .tilizy/services.yaml. Without a type, lists what is available. |
service:list | Lists the declared services. |
service:cli <name> | Opens the client of a service, such as an SQL shell or redis-cli. |
service:remove <name> | Removes a service from the file. |
service:upgrade [name][@version] | Upgrades the version of a service on your computer. |
db, files and snapshot
| Command | What it does | Without a flag, acts on |
db:pull | Refreshes your local database from a hosted environment, with personal data replaced. | Copies from live |
db:dump | Writes a database to a file. | Local |
db:load [file] | Loads a dump into a database. | Local |
db:shell | Opens an SQL shell. | Local |
files:pull | Copies the persistent folders of a hosted environment to your computer. | Copies from live |
files:list | Lists the contents of a persistent folder. | Live |
files:download | Downloads a persistent folder as an archive. | Live |
files:upload [local] | Uploads files into a persistent folder. | Live |
files:rm | Deletes a path inside a persistent folder. | Live |
snapshot:create [name] | Saves a checkpoint of the local database. | Local |
snapshot:list | Lists the local checkpoints. | Local |
snapshot:restore [name] | Returns the local database to a checkpoint. | Local |
snapshot:delete <name> | Deletes a checkpoint. | Local |
backup, var, domain and activity
| Command | What it does |
backup:create | Makes a backup of an environment now. Live unless you pass -e. |
backup:list | Lists the recent backups of a project. |
backup:restore | Restores a backup into its environment. |
var:list | Lists the secrets of a project, without their values. |
var:get [NAME] | Prints the value of one variable. |
var:set [NAME[=value]] | Sets a value. --scope decides which environments see it. |
var:rm [NAME] | Removes a variable. |
domain:add | Adds a host name to a project. -e binds it to another environment than live. |
domain:list | Lists the host names of a project and their environments. |
domain:remove [hostname] | Removes a host name from a project. |
activity:list | Lists recent jobs of a project. --deploys and --backups narrow the list. |
activity:show <job-number> | Shows one job: its result and the time each step took. |
dev, security and addon
| Command | What it does |
dev:qa | Runs every check your project is set up for. A flag such as --phpstan or --phpunit runs one tool only. |
dev:fix | Applies the automatic code fixers. |
dev:watch | Runs .tilizy/hooks/change when files change. |
dev:xdebug <on|off|status> | Switches step debugging on or off for the local website. |
security:validate | Checks .tilizy/security.yml, the declaration of personal data. --check-schema compares it with the real database. |
addon:list | Lists the command sets that are active. |
Framework commands
| Command | What it does |
drupal:drush | Runs Drush. Short form: drush. |
drupal:login | Opens the local website, signed in through a one-time link. |
drupal:config:status | Shows where the configuration on an environment differs from the repository. |
drupal:config:pull | Brings those differences into the repository. |
laravel:artisan | Runs Artisan. Short form: artisan. |
wordpress:wp | Runs WP-CLI. Short form: wp. |
prestashop:console | Runs the PrestaShop console. Short form: console. |
See Framework commands.
Next: Install the CLI and Deploy from the terminal.