Skip to main content
FreeThree checks for your projectUptime, accessibility, SEO and cookie checks for your project
Menu

Command reference

Find the Tilizy CLI command for a task, by group, with one line for each command.

On this page

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

CommandShows
tilizy --helpThe groups of commands
tilizy help appThe commands of one group, here app
tilizy help --allEvery command
tilizy app:deploy --helpOne command in full, with its scope
tilizy --versionThe installed version

Command groups

GroupWhat 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 frameworkdrupal:*, 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

FlagMeaning
-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.
--stagingThe staging environment.
--prodThe live environment.
--no-inputNever 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.
--helpExplain 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

CommandWhat it does
cli:setupChecks that your account and your computer are ready. --setup walks through the open steps.
cli:updateUpdates the CLI. --check only compares versions.
cli:completionPrints the completion script for bash, zsh, fish or powershell.
cli:shell-initPrints the shell hook that project:go needs.
auth:loginSigns in through your browser. Short form: login.
auth:infoShows the signed-in user and the portal. Short form: whoami.
auth:logoutForgets the sign-in on this computer. --revoke also ends it at the portal.
auth:tokenSigns in with a token, for scripts.

project

CommandWhat it does
project:listLists the projects you can open and marks the ones checked out on this computer. --local lists only those, without contacting the portal.
project:infoShows 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

CommandWhat it doesWithout a flag, acts on
app:initWrites a first .tilizy/app.yaml for the checkout.Your checkout
app:validateChecks the files in .tilizy/.Your checkout
app:startStarts the local website, or resumes a paused hosted environment with -e.Local
app:stopStops the local website, or pauses a hosted environment with -e. --purge also deletes the local data.Local
app:restartRebuilds and restarts the local website.Local
app:poweroffStops every local website on this computer.Local
app:statusShows the state of an environment.Local
app:logs [service]Shows the logs. -f follows them.Local
app:shellOpens a shell in an environment.Local
app:openOpens an environment in the browser. --print prints the address.Local
app:mailOpens the local mail inbox.Local
app:doctorChecks the local website, Docker, the certificates and your access.Local
app:buildRuns the build hooks of the project file.Local
app:composerRuns Composer.Local
app:phpRuns PHP.Local
app:execRuns a command in the local website. --build runs it where the code is writable.Local
app:launchThe first deploy: creates the live environment of a project.Live
app:deployDeploys an environment.Live
app:rollbackReturns an environment to an earlier release. --list shows the choices.Live
app:createCreates an environment from a branch and fills it from live. Needs -e <branch>.Needs -e
app:syncCopies the database and the files of live into another environment. Needs -e <branch>.Needs -e
app:destroyRemoves 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

CommandWhat it does
service:add <type> [name]Adds a service to .tilizy/services.yaml. Without a type, lists what is available.
service:listLists 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

CommandWhat it doesWithout a flag, acts on
db:pullRefreshes your local database from a hosted environment, with personal data replaced.Copies from live
db:dumpWrites a database to a file.Local
db:load [file]Loads a dump into a database.Local
db:shellOpens an SQL shell.Local
files:pullCopies the persistent folders of a hosted environment to your computer.Copies from live
files:listLists the contents of a persistent folder.Live
files:downloadDownloads a persistent folder as an archive.Live
files:upload [local]Uploads files into a persistent folder.Live
files:rmDeletes a path inside a persistent folder.Live
snapshot:create [name]Saves a checkpoint of the local database.Local
snapshot:listLists 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

CommandWhat it does
backup:createMakes a backup of an environment now. Live unless you pass -e.
backup:listLists the recent backups of a project.
backup:restoreRestores a backup into its environment.
var:listLists 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:addAdds a host name to a project. -e binds it to another environment than live.
domain:listLists the host names of a project and their environments.
domain:remove [hostname]Removes a host name from a project.
activity:listLists 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

CommandWhat it does
dev:qaRuns every check your project is set up for. A flag such as --phpstan or --phpunit runs one tool only.
dev:fixApplies the automatic code fixers.
dev:watchRuns .tilizy/hooks/change when files change.
dev:xdebug <on|off|status>Switches step debugging on or off for the local website.
security:validateChecks .tilizy/security.yml, the declaration of personal data. --check-schema compares it with the real database.
addon:listLists the command sets that are active.

Framework commands

CommandWhat it does
drupal:drushRuns Drush. Short form: drush.
drupal:loginOpens the local website, signed in through a one-time link.
drupal:config:statusShows where the configuration on an environment differs from the repository.
drupal:config:pullBrings those differences into the repository.
laravel:artisanRuns Artisan. Short form: artisan.
wordpress:wpRuns WP-CLI. Short form: wp.
prestashop:consoleRuns the PrestaShop console. Short form: console.

See Framework commands.

Next: Install the CLI and Deploy from the terminal.