Package Exports

@liara/cli
@liara/cli/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@liara/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@liara/cli

The command line interface for Liara

@liara/cli
Usage
Commands

Usage

$ npm install -g @liara/cli
$ liara COMMAND
running command...
$ liara (--version|-v)
@liara/cli/3.2.0 linux-x64 node-v16.18.0
$ liara --help [COMMAND]
USAGE
  $ liara COMMAND
...

Commands

liara account add
liara account list
liara account ls
liara account remove
liara account rm
liara account use
liara app create
liara app delete
liara app list
liara app logs
liara app ls
liara app restart
liara app shell
liara app start
liara app stop
liara autocomplete [SHELL]
liara create
liara db list
liara db ls
liara delete
liara deploy
liara disk create
liara env list
liara env ls
liara env set [ENV]
liara env unset [ENV]
liara help [COMMAND]
liara login
liara logs
liara plan list
liara plan ls
liara restart
liara shell
liara start
liara stop
liara version

`liara account add`

add an account

USAGE
  $ liara account add [-h] [--debug] [--api-token <value>] [--region iran|germany] [-e <value>] [-p <value>] [-a
    <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
  --region=<option>       the region you want to deploy your app to
                          <options: iran|germany>

DESCRIPTION
  add an account

`liara account list`

list available accounts

USAGE
  $ liara account list [-h] [--debug] [--api-token <value>] [--region iran|germany] [--columns <value> | -x]
    [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -h, --help           Show CLI help.
  -x, --extended       show extra columns
  --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>
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>
  --sort=<value>       property to sort by (prepend '-' for descending)

DESCRIPTION
  list available accounts

ALIASES
  $ liara account ls

`liara account ls`

list available accounts

USAGE
  $ liara account ls [-h] [--debug] [--api-token <value>] [--region iran|germany] [--columns <value> | -x]
    [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -h, --help           Show CLI help.
  -x, --extended       show extra columns
  --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>
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>
  --sort=<value>       property to sort by (prepend '-' for descending)

DESCRIPTION
  list available accounts

ALIASES
  $ liara account ls

`liara account remove`

remove an account

USAGE
  $ liara account remove [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <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
  --region=<option>      the region you want to deploy your app to
                         <options: iran|germany>

DESCRIPTION
  remove an account

ALIASES
  $ liara account rm

`liara account rm`

remove an account

USAGE
  $ liara account rm [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <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
  --region=<option>      the region you want to deploy your app to
                         <options: iran|germany>

DESCRIPTION
  remove an account

ALIASES
  $ liara account rm

`liara account use`

select an account

USAGE
  $ liara account use [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <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
  --region=<option>      the region you want to deploy your app to
                         <options: iran|germany>

DESCRIPTION
  select an account

`liara app create`

create an app

USAGE
  $ liara app create [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>] [--platform
    <value>] [--plan <value>]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --plan=<value>       plan
  --platform=<value>   platform
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  create an app

ALIASES
  $ liara create

`liara app delete`

delete an app

USAGE
  $ liara app delete [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  delete an app

ALIASES
  $ liara delete

`liara app list`

list available apps

USAGE
  $ liara app list [-h] [--debug] [--api-token <value>] [--region iran|germany] [--columns <value> | -x]
    [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -h, --help           Show CLI help.
  -x, --extended       show extra columns
  --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>
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>
  --sort=<value>       property to sort by (prepend '-' for descending)

DESCRIPTION
  list available apps

ALIASES
  $ liara app ls

`liara app logs`

fetch the logs of an app

USAGE
  $ liara app logs [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>] [-s <value>]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  -s, --since=<value>  show logs since timestamp
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  fetch the logs of an app

ALIASES
  $ liara logs

`liara app ls`

list available apps

USAGE
  $ liara app ls [-h] [--debug] [--api-token <value>] [--region iran|germany] [--columns <value> | -x]
    [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -h, --help           Show CLI help.
  -x, --extended       show extra columns
  --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>
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>
  --sort=<value>       property to sort by (prepend '-' for descending)

DESCRIPTION
  list available apps

ALIASES
  $ liara app ls

`liara app restart`

restart an app

USAGE
  $ liara app restart [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  restart an app

ALIASES
  $ liara restart

`liara app shell`

run a command in a running applet

USAGE
  $ liara app shell [-h] [--debug] [--api-token <value>] [--region iran|germany] [-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.
  --api-token=<value>    your api token to use for authentication
  --debug                show debug logs
  --region=<option>      the region you want to deploy your app to
                         <options: iran|germany>

DESCRIPTION
  run a command in a running applet

ALIASES
  $ liara shell

`liara app start`

start an app

USAGE
  $ liara app start [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  start an app

ALIASES
  $ liara start

`liara app stop`

stop an app

USAGE
  $ liara app stop [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  stop an app

ALIASES
  $ liara stop

`liara autocomplete [SHELL]`

display autocomplete installation instructions

USAGE
  $ liara autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  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 --refresh-cache

See code: @oclif/plugin-autocomplete

`liara create`

create an app

USAGE
  $ liara create [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>] [--platform
    <value>] [--plan <value>]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --plan=<value>       plan
  --platform=<value>   platform
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  create an app

ALIASES
  $ liara create

`liara db list`

list available databases

USAGE
  $ liara db list [-h] [--debug] [--api-token <value>] [--region iran|germany] [--columns <value> | -x]
    [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -h, --help           Show CLI help.
  -x, --extended       show extra columns
  --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>
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>
  --sort=<value>       property to sort by (prepend '-' for descending)

DESCRIPTION
  list available databases

ALIASES
  $ liara db ls

`liara db ls`

list available databases

USAGE
  $ liara db ls [-h] [--debug] [--api-token <value>] [--region iran|germany] [--columns <value> | -x]
    [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -h, --help           Show CLI help.
  -x, --extended       show extra columns
  --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>
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>
  --sort=<value>       property to sort by (prepend '-' for descending)

DESCRIPTION
  list available databases

ALIASES
  $ liara db ls

`liara delete`

delete an app

USAGE
  $ liara delete [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  delete an app

ALIASES
  $ liara delete

`liara deploy`

deploy an app

USAGE
  $ liara deploy [-h] [--debug] [--api-token <value>] [--region iran|germany] [--path <value>] [--platform
    <value>] [-a <value>] [-p <value>] [-i <value>] [--detach] [--args <value>] [--build-arg <value>] [-m <value>] [-d
    <value>] [--no-cache]

FLAGS
  -a, --app=<value>       app id
  -d, --disks=<value>...  mount a disk
  -h, --help              Show CLI help.
  -i, --image=<value>     docker image to deploy
  -m, --message=<value>   the release message
  -p, --port=<value>      the port that your app listens to
  --api-token=<value>     your api token to use for authentication
  --args=<value>...       docker image entrypoint args
  --build-arg=<value>...  docker image build args
  --debug                 show debug logs
  --detach                do not stream app logs after deployment
  --no-cache              do not use cache when building the image
  --path=<value>          app path in your computer
  --platform=<value>      the platform your app needs to run
  --region=<option>       the region you want to deploy your app to
                          <options: iran|germany>

DESCRIPTION
  deploy an app

See code: src/commands/deploy.ts

`liara disk create`

create a disk

USAGE
  $ liara disk create [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>] [-n <value>] [-s
    <value>]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  -n, --name=<value>   disk name
  -s, --size=<value>   disk size
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  create a disk

`liara env list`

list environment variables of an app

USAGE
  $ liara env list [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>] [--columns
    <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header
    | ]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  -x, --extended       show extra columns
  --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>
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>
  --sort=<value>       property to sort by (prepend '-' for descending)

DESCRIPTION
  list environment variables of an app

ALIASES
  $ liara env ls

`liara env ls`

list environment variables of an app

USAGE
  $ liara env ls [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>] [--columns
    <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header
    | ]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  -x, --extended       show extra columns
  --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>
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>
  --sort=<value>       property to sort by (prepend '-' for descending)

DESCRIPTION
  list environment variables of an app

ALIASES
  $ liara env ls

`liara env set [ENV]`

specifying environment variables to an app

USAGE
  $ liara env set [ENV] [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>] [-f]

ARGUMENTS
  ENV  key=value pair

FLAGS
  -a, --app=<value>    app id
  -f, --force          force update
  -h, --help           Show CLI help.
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  specifying environment variables to an app

`liara env unset [ENV]`

remove environment variables from an app

USAGE
  $ liara env unset [ENV] [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>] [-f]

ARGUMENTS
  ENV  key

FLAGS
  -a, --app=<value>    app id
  -f, --force          force update
  -h, --help           Show CLI help.
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  remove environment variables from an app

`liara help [COMMAND]`

Display help for liara.

USAGE
  $ liara help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for liara.

See code: @oclif/plugin-help

`liara login`

USAGE
  $ liara login [-h] [--debug] [--api-token <value>] [--region iran|germany] [-e <value>] [-p <value>]

FLAGS
  -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
  --region=<option>       the region you want to deploy your app to
                          <options: iran|germany>

DESCRIPTION
  login to your account

See code: src/commands/login.ts

`liara logs`

fetch the logs of an app

USAGE
  $ liara logs [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>] [-s <value>]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  -s, --since=<value>  show logs since timestamp
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  fetch the logs of an app

ALIASES
  $ liara logs

`liara plan list`

list available plans

USAGE
  $ liara plan list [-h] [--debug] [--api-token <value>] [--region iran|germany] [--columns <value> | -x]
    [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -h, --help           Show CLI help.
  -x, --extended       show extra columns
  --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>
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>
  --sort=<value>       property to sort by (prepend '-' for descending)

DESCRIPTION
  list available plans

ALIASES
  $ liara plan ls

`liara plan ls`

list available plans

USAGE
  $ liara plan ls [-h] [--debug] [--api-token <value>] [--region iran|germany] [--columns <value> | -x]
    [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -h, --help           Show CLI help.
  -x, --extended       show extra columns
  --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>
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>
  --sort=<value>       property to sort by (prepend '-' for descending)

DESCRIPTION
  list available plans

ALIASES
  $ liara plan ls

`liara restart`

restart an app

USAGE
  $ liara restart [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  restart an app

ALIASES
  $ liara restart

`liara shell`

run a command in a running applet

USAGE
  $ liara shell [-h] [--debug] [--api-token <value>] [--region iran|germany] [-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.
  --api-token=<value>    your api token to use for authentication
  --debug                show debug logs
  --region=<option>      the region you want to deploy your app to
                         <options: iran|germany>

DESCRIPTION
  run a command in a running applet

ALIASES
  $ liara shell

`liara start`

start an app

USAGE
  $ liara start [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  start an app

ALIASES
  $ liara start

`liara stop`

stop an app

USAGE
  $ liara stop [-h] [--debug] [--api-token <value>] [--region iran|germany] [-a <value>]

FLAGS
  -a, --app=<value>    app id
  -h, --help           Show CLI help.
  --api-token=<value>  your api token to use for authentication
  --debug              show debug logs
  --region=<option>    the region you want to deploy your app to
                       <options: iran|germany>

DESCRIPTION
  stop an app

ALIASES
  $ liara stop

`liara version`

USAGE
  $ liara version [--json] [--verbose]

FLAGS
  --verbose  Show additional information about the CLI.

GLOBAL FLAGS
  --json  Format output as json.

FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.

    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version