0.4.1 • Published 23m agoCLI

@laioutr/cli

Licence

—

Version

0.4.1

Deps

Size

89 kB

Vulns

Weekly

Summary Dependency Versions

@laioutr/cli

Laioutr CLI

@laioutr/cli
Usage
Commands

Usage

$ npm install -g @laioutr/cli
$ laioutr COMMAND
running command...
$ laioutr (--version)
@laioutr/cli/0.4.1 linux-x64 node-v24.18.0
$ laioutr --help [COMMAND]
USAGE
  $ laioutr COMMAND
...

Commands

laioutr app release
laioutr deploy list
laioutr deploy logs
laioutr deploy status
laioutr deploy trigger
laioutr help [COMMAND]
laioutr plugins
laioutr plugins add PLUGIN
laioutr plugins:inspect PLUGIN...
laioutr plugins install PLUGIN
laioutr plugins link PATH
laioutr plugins remove [PLUGIN]
laioutr plugins reset
laioutr plugins uninstall [PLUGIN]
laioutr plugins unlink [PLUGIN]
laioutr plugins update
laioutr project fetch-rc [FILENAME]
laioutr rc fetch [FILENAME]
laioutr rc update [FILENAME]

`laioutr app release`

Publish an app version to the Laioutr platform.

USAGE
  $ laioutr app release --cockpit-api-host <value> --cwd <value> -k <value> [--no-color] [-c stable|testing]

FLAGS
  -c, --channel=<option>          Release channel (auto-detected from version if omitted)
                                  <options: stable|testing>
  -k, --key=<value>               (required) API key for authentication
      --cockpit-api-host=<value>  (required) [default: https://cockpit.laioutr.cloud] Cockpit API host
      --cwd=<value>               (required) [default: /home/runner/work/laioutr/laioutr/apps/cli] Current working
                                  directory
      --no-color                  Disable color in output

DESCRIPTION
  Publish an app version to the Laioutr platform.

EXAMPLES
  $ laioutr app release

  $ laioutr app release --channel testing

  LAIOUTR_API_KEY=orgKey_xxx laioutr app release

See code: src/commands/app/release.ts

`laioutr deploy list`

List recent deployments for a project.

USAGE
  $ laioutr deploy list --cockpit-api-host <value> --cwd <value> -p <value> -k <value> [--json] [--no-color]
    [--limit <value>]

FLAGS
  -k, --key=<value>               (required) Organization API key with project:deploy scope
  -p, --project=<value>           (required) Project identifier in org/project format
      --cockpit-api-host=<value>  (required) [default: https://cockpit.laioutr.cloud] Cockpit API host
      --cwd=<value>               (required) [default: /home/runner/work/laioutr/laioutr/apps/cli] Current working
                                  directory
      --limit=<value>             [default: 20] Maximum number of deployments to list (1-100)
      --no-color                  Disable color in output

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List recent deployments for a project.

EXAMPLES
  $ laioutr deploy list --project org/project --key orgKey_xxx

  $ laioutr deploy list --project org/project --key orgKey_xxx --limit 50

See code: src/commands/deploy/list.ts

`laioutr deploy logs`

Fetch and display build logs for a deployment.

USAGE
  $ laioutr deploy logs --cockpit-api-host <value> --cwd <value> -p <value> -k <value> --deployment-id <value>
    [--json] [--no-color]

FLAGS
  -k, --key=<value>               (required) Organization API key with project:deploy scope
  -p, --project=<value>           (required) Project identifier in org/project format
      --cockpit-api-host=<value>  (required) [default: https://cockpit.laioutr.cloud] Cockpit API host
      --cwd=<value>               (required) [default: /home/runner/work/laioutr/laioutr/apps/cli] Current working
                                  directory
      --deployment-id=<value>     (required) Deployment ID
      --no-color                  Disable color in output

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Fetch and display build logs for a deployment.

EXAMPLES
  $ laioutr deploy logs --project org/project --key orgKey_xxx --deployment-id dep_abc123

See code: src/commands/deploy/logs.ts

`laioutr deploy status`

Show status of a deployment.

USAGE
  $ laioutr deploy status --cockpit-api-host <value> --cwd <value> -p <value> -k <value> --deployment-id <value>
    [--json] [--no-color]

FLAGS
  -k, --key=<value>               (required) Organization API key with project:deploy scope
  -p, --project=<value>           (required) Project identifier in org/project format
      --cockpit-api-host=<value>  (required) [default: https://cockpit.laioutr.cloud] Cockpit API host
      --cwd=<value>               (required) [default: /home/runner/work/laioutr/laioutr/apps/cli] Current working
                                  directory
      --deployment-id=<value>     (required) Deployment ID
      --no-color                  Disable color in output

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Show status of a deployment.

EXAMPLES
  $ laioutr deploy status --project org/project --key orgKey_xxx --deployment-id dep_abc123

See code: src/commands/deploy/status.ts

`laioutr deploy trigger`

Trigger a project deployment.

USAGE
  $ laioutr deploy trigger --cockpit-api-host <value> --cwd <value> -p <value> -k <value> [--json] [--no-color]
    [--wait] [--logs] [--preview <value>]

FLAGS
  -k, --key=<value>               (required) Organization API key with project:deploy scope
  -p, --project=<value>           (required) Project identifier in org/project format
      --cockpit-api-host=<value>  (required) [default: https://cockpit.laioutr.cloud] Cockpit API host
      --cwd=<value>               (required) [default: /home/runner/work/laioutr/laioutr/apps/cli] Current working
                                  directory
      --logs                      Stream build log output instead of spinner
      --no-color                  Disable color in output
      --preview=<value>           Create a preview deployment with optional name
      --[no-]wait                 Wait for deployment to complete

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Trigger a project deployment.

EXAMPLES
  $ laioutr deploy trigger --project org/project --key orgKey_xxx

  $ laioutr deploy trigger --project org/project --key orgKey_xxx --no-wait

  $ laioutr deploy trigger --project org/project --key orgKey_xxx --logs

  $ laioutr deploy trigger --project org/project --key orgKey_xxx --preview my-feature

See code: src/commands/deploy/trigger.ts

`laioutr help [COMMAND]`

Display help for laioutr.

USAGE
  $ laioutr 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 laioutr.

See code: @oclif/plugin-help

`laioutr plugins`

List installed plugins.

USAGE
  $ laioutr plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ laioutr plugins

See code: @oclif/plugin-plugins

`laioutr plugins add PLUGIN`

Installs a plugin into laioutr.

USAGE
  $ laioutr plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into laioutr.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the LAIOUTR_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the LAIOUTR_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ laioutr plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ laioutr plugins add myplugin

  Install a plugin from a github url.

    $ laioutr plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ laioutr plugins add someuser/someplugin

`laioutr plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

USAGE
  $ laioutr plugins inspect PLUGIN...

ARGUMENTS
  PLUGIN...  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ laioutr plugins inspect myplugin

See code: @oclif/plugin-plugins

`laioutr plugins install PLUGIN`

Installs a plugin into laioutr.

USAGE
  $ laioutr plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into laioutr.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the LAIOUTR_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the LAIOUTR_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ laioutr plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ laioutr plugins install myplugin

  Install a plugin from a github url.

    $ laioutr plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ laioutr plugins install someuser/someplugin

See code: @oclif/plugin-plugins

`laioutr plugins link PATH`

Links a plugin into the CLI for development.

USAGE
  $ laioutr plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ laioutr plugins link myplugin

See code: @oclif/plugin-plugins

`laioutr plugins remove [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ laioutr plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ laioutr plugins unlink
  $ laioutr plugins remove

EXAMPLES
  $ laioutr plugins remove myplugin

`laioutr plugins reset`

Remove all user-installed and linked plugins.

USAGE
  $ laioutr plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

`laioutr plugins uninstall [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ laioutr plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ laioutr plugins unlink
  $ laioutr plugins remove

EXAMPLES
  $ laioutr plugins uninstall myplugin

See code: @oclif/plugin-plugins

`laioutr plugins unlink [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ laioutr plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ laioutr plugins unlink
  $ laioutr plugins remove

EXAMPLES
  $ laioutr plugins unlink myplugin

`laioutr plugins update`

Update installed plugins.

USAGE
  $ laioutr plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

`laioutr project fetch-rc [FILENAME]`

Fetches the laioutrrc.json of a project from the cockpit api.

USAGE
  $ laioutr project fetch-rc [FILENAME] --cockpit-api-host <value> --cwd <value> -e <value> -s <value> -p <value>
    [--no-color]

FLAGS
  -e, --environment-name=<value>  (required) [default: main] Environment name
  -p, --project=<value>           (required) <organization slug>/<project slug>
  -s, --project-secret=<value>    (required) Project secret
      --cockpit-api-host=<value>  (required) [default: https://cockpit.laioutr.cloud] Cockpit API host
      --cwd=<value>               (required) [default: /home/runner/work/laioutr/laioutr/apps/cli] Current working
                                  directory
      --no-color                  Disable color in output

DESCRIPTION
  Fetches the laioutrrc.json of a project from the cockpit api.

ALIASES
  $ laioutr project fetch-rc

EXAMPLES
  $ laioutr project fetch-rc

`laioutr rc fetch [FILENAME]`

Fetches the laioutrrc.json of a project from the cockpit api.

USAGE
  $ laioutr rc fetch [FILENAME] --cockpit-api-host <value> --cwd <value> -e <value> -s <value> -p <value>
    [--no-color]

FLAGS
  -e, --environment-name=<value>  (required) [default: main] Environment name
  -p, --project=<value>           (required) <organization slug>/<project slug>
  -s, --project-secret=<value>    (required) Project secret
      --cockpit-api-host=<value>  (required) [default: https://cockpit.laioutr.cloud] Cockpit API host
      --cwd=<value>               (required) [default: /home/runner/work/laioutr/laioutr/apps/cli] Current working
                                  directory
      --no-color                  Disable color in output

DESCRIPTION
  Fetches the laioutrrc.json of a project from the cockpit api.

ALIASES
  $ laioutr project fetch-rc

EXAMPLES
  $ laioutr rc fetch

See code: src/commands/rc/fetch.ts

`laioutr rc update [FILENAME]`

Updates an existing laioutrrc.json file with the latest from the cockpit api.

USAGE
  $ laioutr rc update [FILENAME] --cockpit-api-host <value> --cwd <value> [--no-color]

FLAGS
  --cockpit-api-host=<value>  (required) [default: https://cockpit.laioutr.cloud] Cockpit API host
  --cwd=<value>               (required) [default: /home/runner/work/laioutr/laioutr/apps/cli] Current working directory
  --no-color                  Disable color in output

DESCRIPTION
  Updates an existing laioutrrc.json file with the latest from the cockpit api.

EXAMPLES
  $ laioutr rc update

See code: src/commands/rc/update.ts