liara-cloud/cli(opens in a new tab)
Language: TypeScript
The command line interface for Liara
- stars
- 118
- watchers
- 6
- forks
- 16
- open issues
- 0
- Last updated
- 10/27/2026
Language: TypeScript
The command line interface for Liara
The command line interface for Liara
$ npm install -g @liara/cli $ liara COMMAND running command... $ liara (--version|-v) @liara/cli/9.6.3 linux-x64 node-v22.13.1 $ liara --help [COMMAND] USAGE $ liara COMMAND ...
liara account addliara account listliara account lsliara account removeliara account rmliara account useliara account whoamiliara app createliara app deleteliara app listliara app logsliara app lsliara app removeliara app restartliara app rmliara app shellliara app startliara app stopliara app update-portliara autocomplete [SHELL]liara bucket createliara bucket deleteliara bucket listliara bucket lsliara createliara db backup createliara db backup dlliara db backup downloadliara db backup listliara db backup lsliara db createliara db listliara db lsliara db removeliara db resizeliara db rmliara db startliara db stopliara deleteliara deployliara disk createliara env listliara env lsliara env set [ENV]liara env unset [ENV]liara help [COMMAND]liara initliara loginliara logsliara mail createliara mail deleteliara mail listliara mail lsliara mail sendliara network createliara network listliara network lsliara plan listliara plan lsliara restartliara shellliara startliara stopliara team change-ownerliara team createliara team deleteliara team invitation createliara team invitation deleteliara team invitation joinliara team invitation listliara team invitation lsliara team invitation rmliara team inviteliara team joinliara team leaveliara team listliara team lsliara team member listliara team member lsliara team member removeliara team member rmliara team member set-roleliara team permission assignliara team permission listliara team permission lsliara team permission revokeliara team renameliara team rmliara team role createliara team role deleteliara team role listliara team role lsliara team role rmliara team useliara update-portliara versionliara vm createliara vm deleteliara vm infoliara vm inspectliara vm listliara vm power offliara vm restartliara vm rmliara vm showliara vm shutdownliara vm startliara vm stopliara whoamiliara zone chliara zone checkliara zone createliara zone delliara zone deleteliara zone getliara zone listliara zone lsliara zone record create ZONEliara zone record getliara zone record listliara zone record lsliara zone record removeliara zone record rmliara zone record updateliara zone rmadd an account
USAGE
$ liara account add [-h] [--debug] [--api-token <value>] [-a <value>] [--team-id <value>] [-e <value>] [-p
<value>]
FLAGS
-a, --account=<value> account name
-e, --email=<value> your email
-h, --help Show CLI help.
-p, --password=<value> your password
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
add an account
See code: src/commands/account/add.ts
list available accounts
USAGE
$ liara account list [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [--columns
<value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort
<value>]
FLAGS
-h, --help Show CLI help.
-x, --extended show extra columns
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug show debug logs
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
list available accounts
ALIASES
$ liara account ls
See code: src/commands/account/list.ts
list available accounts
USAGE
$ liara account ls [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [--columns
<value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort
<value>]
FLAGS
-h, --help Show CLI help.
-x, --extended show extra columns
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug show debug logs
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
list available accounts
ALIASES
$ liara account ls
remove an account
USAGE
$ liara account remove [-h] [--debug] [--api-token <value>] [-a <value>] [--team-id <value>]
FLAGS
-a, --account=<value> account name
-h, --help Show CLI help.
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
remove an account
ALIASES
$ liara account rm
See code: src/commands/account/remove.ts
remove an account
USAGE
$ liara account rm [-h] [--debug] [--api-token <value>] [-a <value>] [--team-id <value>]
FLAGS
-a, --account=<value> account name
-h, --help Show CLI help.
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
remove an account
ALIASES
$ liara account rm
select an account
USAGE
$ liara account use [-h] [--debug] [--api-token <value>] [-a <value>] [--team-id <value>]
FLAGS
-a, --account=<value> account name
-h, --help Show CLI help.
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
select an account
See code: src/commands/account/use.ts
show the account and team that commands run as
USAGE
$ liara account whoami [--json] [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>]
FLAGS
-h, --help Show CLI help.
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
show the account and team that commands run as
The team comes from --team-id, then the team selected via 'liara team:use'. Without either, commands run on your
personal account.
ALIASES
$ liara account whoami
create an app
USAGE
$ liara app create [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-a <value>]
[--platform <value>] [--plan <value>] [--feature-plan <value>] [-n <value>] [-r true|false]
FLAGS
-a, --app=<value> app id
-h, --help Show CLI help.
-n, --network=<value> network
-r, --read-only=<option> read-only filesystem
<options: true|false>
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--feature-plan=<value> feature bundle plan
--plan=<value> plan
--platform=<value> platform
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
create an app
ALIASES
$ liara create
See code: src/commands/app/create.ts
delete an app
USAGE
$ liara app delete [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-a <value>]
FLAGS
-a, --app=<value> app id
-h, --help Show CLI help.
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
delete an app
ALIASES
$ liara delete
$ liara app remove
$ liara app rm
See code: src/commands/app/delete.ts
list available apps
USAGE
$ liara app list [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [--columns
<value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort
<value>]
FLAGS
-h, --help Show CLI help.
-x, --extended show extra columns
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug show debug logs
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
list available apps
ALIASES
$ liara app ls
See code: src/commands/app/list.ts
fetch the logs of an app
USAGE
$ liara app logs [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-a <value>]
[-s <value>] [-t] [-f] [-c] [-r <value>] [-l]
FLAGS
-a, --app=<value> app id
-c, --colorize colorize log output
-f, --follow follow log output
-h, --help Show CLI help.
-l, --last-lines
-r, --release=<value> show logs for a specific release (e.g. v1, v2)
-s, --since=<value> show logs since a specific time in the past (e.g. "1 hour ago")
-t, --timestamps show timestamps
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
fetch the logs of an app
ALIASES
$ liara logs
See code: src/commands/app/logs.ts
list available apps
USAGE
$ liara app ls [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [--columns
<value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort
<value>]
FLAGS
-h, --help Show CLI help.
-x, --extended show extra columns
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug show debug logs
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
list available apps
ALIASES
$ liara app ls
delete an app
USAGE
$ liara app remove [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-a <value>]
FLAGS
-a, --app=<value> app id
-h, --help Show CLI help.
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
delete an app
ALIASES
$ liara delete
$ liara app remove
$ liara app rm
restart an app
USAGE
$ liara app restart [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-a <value>]
FLAGS
-a, --app=<value> app id
-h, --help Show CLI help.
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
restart an app
ALIASES
$ liara restart
See code: src/commands/app/restart.ts
delete an app
USAGE
$ liara app rm [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-a <value>]
FLAGS
-a, --app=<value> app id
-h, --help Show CLI help.
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
delete an app
ALIASES
$ liara delete
$ liara app remove
$ liara app rm
run a command in a running applet
USAGE
$ liara app shell [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-a <value>]
[-c <value>]
FLAGS
-a, --app=<value> app id
-c, --command=<value> [default: /bin/bash] the command to execute
-h, --help Show CLI help.
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
run a command in a running applet
ALIASES
$ liara shell
See code: src/commands/app/shell.ts
start an app
USAGE
$ liara app start [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-a <value>]
FLAGS
-a, --app=<value> app id
-h, --help Show CLI help.
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
start an app
ALIASES
$ liara start
See code: src/commands/app/start.ts
stop an app
USAGE
$ liara app stop [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-a <value>]
FLAGS
-a, --app=<value> app id
-h, --help Show CLI help.
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
stop an app
ALIASES
$ liara stop
See code: src/commands/app/stop.ts
update an app's port
USAGE
$ liara app update-port [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-a <value>]
[-p <value>]
FLAGS
-a, --app=<value> app id
-h, --help Show CLI help.
-p, --port=<value> desired port
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
update an app's port
ALIASES
$ liara update-port
$ liara app update-port
See code: src/commands/app/update-port.ts
Display autocomplete installation instructions.
USAGE
$ liara autocomplete [SHELL] [-r]
ARGUMENTS
[SHELL] (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ liara autocomplete
$ liara autocomplete bash
$ liara autocomplete zsh
$ liara autocomplete powershell
$ liara autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
create a bucket
USAGE
$ liara bucket create [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [--name
<value>] [--permission <value>] [--plan <value>]
FLAGS
-h, --help Show CLI help.
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--name=<value> name
--permission=<value> permission
--plan=<value> plan
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
create a bucket
ALIASES
$ liara bucket create
See code: src/commands/bucket/create.ts
delete a bucket
USAGE
$ liara bucket delete [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-b <value>]
[-f]
FLAGS
-b, --bucket=<value> bucket name
-f, --force force the deletion
-h, --help Show CLI help.
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
delete a bucket
ALIASES
$ liara bucket delete
See code: src/commands/bucket/delete.ts
list available buckets
USAGE
$ liara bucket list [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [--columns
<value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort
<value>]
FLAGS
-h, --help Show CLI help.
-x, --extended show extra columns
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug show debug logs
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
list available buckets
ALIASES
$ liara bucket ls
See code: src/commands/bucket/list.ts
list available buckets
USAGE
$ liara bucket ls [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [--columns
<value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort
<value>]
FLAGS
-h, --help Show CLI help.
-x, --extended show extra columns
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug show debug logs
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
list available buckets
ALIASES
$ liara bucket ls
create an app
USAGE
$ liara create [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-a <value>]
[--platform <value>] [--plan <value>] [--feature-plan <value>] [-n <value>] [-r true|false]
FLAGS
-a, --app=<value> app id
-h, --help Show CLI help.
-n, --network=<value> network
-r, --read-only=<option> read-only filesystem
<options: true|false>
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--feature-plan=<value> feature bundle plan
--plan=<value> plan
--platform=<value> platform
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
create an app
ALIASES
$ liara create
create a database backup
USAGE
$ liara db backup create [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-n <value>]
FLAGS
-h, --help Show CLI help.
-n, --name=<value> name of your database
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
create a database backup
See code: src/commands/db/backup/create.ts
download a database backup
USAGE
$ liara db backup dl [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-n <value>]
[-b <value>] [-o <value>]
FLAGS
-b, --backup=<value> select which backup to download
-h, --help Show CLI help.
-n, --name=<value> name of your database
-o, --output=<value> download the backup file and save it as the given name in the current working directory
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
download a database backup
ALIASES
$ liara db backup dl
download a database backup
USAGE
$ liara db backup download [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-n <value>]
[-b <value>] [-o <value>]
FLAGS
-b, --backup=<value> select which backup to download
-h, --help Show CLI help.
-n, --name=<value> name of your database
-o, --output=<value> download the backup file and save it as the given name in the current working directory
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--debug show debug logs
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
download a database backup
ALIASES
$ liara db backup dl
See code: src/commands/db/backup/download.ts
list backups for a database
USAGE
$ liara db backup list [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-n <value>]
[--columns <value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ]
[--sort <value>]
FLAGS
-h, --help Show CLI help.
-n, --name=<value> name of your database
-x, --extended show extra columns
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug show debug logs
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
list backups for a database
ALIASES
$ liara db backup ls
See code: src/commands/db/backup/list.ts
list backups for a database
USAGE
$ liara db backup ls [-h] [--debug] [--api-token <value>] [--account <value>] [--team-id <value>] [-n <value>]
[--columns <value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ]
[--sort <value>]
FLAGS
-h, --help Show CLI help.
-n, --name=<value> name of your database
-x, --extended show extra columns
--account=<value> temporarily switch to a different account
--api-token=<value> your api token to use for authentication
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug show debug logs
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
--team-id=<value> your team id (defaults to the team selected via 'liara team:use')
DESCRIPTION
list backups for a database
ALIASES
$ liara db backup ls
create a new database
USAGE
$ liara db