Socket
Book a DemoInstallSign in
Socket
Book a DemoInstallSign in

@livecycle/preview

Package Overview
Dependencies
Maintainers
2
Versions
3
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install
Package was removed
Sorry, it seems this package was removed from the registry

@livecycle/preview

Quickly deploy preview environments to the cloud!

unpublished
latest
Source
npmnpm
Version
0.0.2
Version published
Weekly downloads
0
Maintainers
2
Weekly downloads
 
Created
Source

oclif-hello-world

oclif example Hello World CLI

oclif Version CircleCI Downloads/week License

  • Usage
  • Commands

Usage

$ npm install -g @livecycle/preview
$ preview COMMAND
running command...
$ preview (--version)
@livecycle/preview/0.0.2 linux-x64 node-v18.15.0
$ preview --help [COMMAND]
USAGE
  $ preview COMMAND
...

Commands

preview down

Delete preview environments

USAGE
  $ preview down [--log-level debug|info|warn|error] [-d lightsail|fake] [--lightsail-region
    us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-southeast-2|ap-northeast-1|ca-central-1|eu
    -central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1] [--lightsail-availability-zone <value>] [--id <value>] [-f
    <value>] [-p <value>] [-f] [--json]

FLAGS
  -d, --driver=<option>                  [default: lightsail] Machine driver to use
                                         <options: lightsail|fake>
  -f, --file=<value>...                  [default: ] Compose configuration file
  -f, --force                            Do not error if the environment is not found
  -p, --project=<value>                  Project name. Defaults to the Compose project name
  --id=<value>                           Environment id - affects created URLs. If not specified, will try to detect
                                         automatically
  --lightsail-availability-zone=<value>  AWS availability zone to provision resources in region
  --lightsail-region=<option>            AWS region to provision resources in
                                         <options: us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-
                                         1|ap-southeast-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|e
                                         u-west-3|eu-north-1>

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|info|warn|error>

DESCRIPTION
  Delete preview environments

See code: dist/commands/down/index.ts

preview help [COMMANDS]

Display help for preview.

USAGE
  $ preview help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

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

DESCRIPTION
  Display help for preview.

See code: @oclif/plugin-help

preview init [PROFILE-ALIAS]

Initialize or import a new profile

USAGE
  $ preview init [PROFILE-ALIAS] [--log-level debug|info|warn|error] [-f <value>]

ARGUMENTS
  PROFILE-ALIAS  [default: default] Alias of the profile

FLAGS
  -f, --from=<value>  Import profile from existing path

GLOBAL FLAGS
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|info|warn|error>

DESCRIPTION
  Initialize or import a new profile

See code: dist/commands/init/index.ts

preview ls

List preview environments

USAGE
  $ preview ls [--log-level debug|info|warn|error] [-d lightsail|fake] [--lightsail-region
    us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-southeast-2|ap-northeast-1|ca-central-1|eu
    -central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1] [--lightsail-availability-zone <value>] [--columns <value> |
    -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]
    [--json]

FLAGS
  -d, --driver=<option>                  [default: lightsail] Machine driver to use
                                         <options: lightsail|fake>
  -x, --extended                         show extra columns
  --columns=<value>                      only show provided columns (comma-separated)
  --csv                                  output is csv format [alias: --output=csv]
  --filter=<value>                       filter property by partial string matching, ex: name=foo
  --lightsail-availability-zone=<value>  AWS availability zone to provision resources in region
  --lightsail-region=<option>            AWS region to provision resources in
                                         <options: us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-
                                         1|ap-southeast-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|e
                                         u-west-3|eu-north-1>
  --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)

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|info|warn|error>

DESCRIPTION
  List preview environments

See code: dist/commands/ls/index.ts

preview plugins

List installed plugins.

USAGE
  $ preview plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ preview plugins

See code: @oclif/plugin-plugins

preview plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ preview plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

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

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ preview plugins add

EXAMPLES
  $ preview plugins:install myplugin 

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

  $ preview plugins:install someuser/someplugin

preview plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ preview 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
  $ preview plugins:inspect myplugin

preview plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ preview plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

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

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ preview plugins add

EXAMPLES
  $ preview plugins:install myplugin 

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

  $ preview plugins:install someuser/someplugin

preview plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ preview plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

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

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
  $ preview plugins:link myplugin

preview plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ preview plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ preview plugins unlink
  $ preview plugins remove

preview plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ preview plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ preview plugins unlink
  $ preview plugins remove

preview plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ preview plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ preview plugins unlink
  $ preview plugins remove

preview plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

preview profile create NAME URL

Create a new profile

USAGE
  $ preview profile create NAME URL [--log-level debug|info|warn|error] [-d lightsail|fake] [--lightsail-region
    us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-southeast-2|ap-northeast-1|ca-central-1|eu
    -central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1] [--lightsail-availability-zone <value>] [--json]

ARGUMENTS
  NAME  name of the new profile
  URL   url of the new profile store

FLAGS
  -d, --driver=<option>                  [default: lightsail] Machine driver to use
                                         <options: lightsail|fake>
  --lightsail-availability-zone=<value>  AWS availability zone to provision resources in region
  --lightsail-region=<option>            AWS region to provision resources in
                                         <options: us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-
                                         1|ap-southeast-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|e
                                         u-west-3|eu-north-1>

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|info|warn|error>

DESCRIPTION
  Create a new profile

preview profile current

Display current profile in use

USAGE
  $ preview profile current [--log-level debug|info|warn|error] [--json]

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|info|warn|error>

DESCRIPTION
  Display current profile in use

preview profile import LOCATION

Import an existing profile

USAGE
  $ preview profile import LOCATION [--log-level debug|info|warn|error] [--name <value>] [--json]

ARGUMENTS
  LOCATION  location of the profile

FLAGS
  --name=<value>  [default: default] name of the profile

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|info|warn|error>

DESCRIPTION
  Import an existing profile

preview profile ls

Lists profiles

USAGE
  $ preview profile ls [--log-level debug|info|warn|error] [-d lightsail|fake] [--lightsail-region
    us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-southeast-2|ap-northeast-1|ca-central-1|eu
    -central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1] [--lightsail-availability-zone <value>] [--json]

FLAGS
  -d, --driver=<option>                  [default: lightsail] Machine driver to use
                                         <options: lightsail|fake>
  --lightsail-availability-zone=<value>  AWS availability zone to provision resources in region
  --lightsail-region=<option>            AWS region to provision resources in
                                         <options: us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-
                                         1|ap-southeast-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|e
                                         u-west-3|eu-north-1>

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|info|warn|error>

DESCRIPTION
  Lists profiles

preview profile rm NAME

Remove a profile

USAGE
  $ preview profile rm NAME [--log-level debug|info|warn|error] [-d lightsail|fake] [--lightsail-region
    us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-southeast-2|ap-northeast-1|ca-central-1|eu
    -central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1] [--lightsail-availability-zone <value>] [--json]

ARGUMENTS
  NAME  name of the profile to remove

FLAGS
  -d, --driver=<option>                  [default: lightsail] Machine driver to use
                                         <options: lightsail|fake>
  --lightsail-availability-zone=<value>  AWS availability zone to provision resources in region
  --lightsail-region=<option>            AWS region to provision resources in
                                         <options: us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-
                                         1|ap-southeast-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|e
                                         u-west-3|eu-north-1>

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|info|warn|error>

DESCRIPTION
  Remove a profile

preview profile use NAME

Set current profile

USAGE
  $ preview profile use NAME [--log-level debug|info|warn|error] [-d lightsail|fake] [--lightsail-region
    us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-southeast-2|ap-northeast-1|ca-central-1|eu
    -central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1] [--lightsail-availability-zone <value>] [--json]

ARGUMENTS
  NAME  name of the profile to use

FLAGS
  -d, --driver=<option>                  [default: lightsail] Machine driver to use
                                         <options: lightsail|fake>
  --lightsail-availability-zone=<value>  AWS availability zone to provision resources in region
  --lightsail-region=<option>            AWS region to provision resources in
                                         <options: us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-
                                         1|ap-southeast-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|e
                                         u-west-3|eu-north-1>

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|info|warn|error>

DESCRIPTION
  Set current profile

preview up

Bring up a preview environment

USAGE
  $ preview up [--log-level debug|info|warn|error] [-d lightsail|fake] [--lightsail-region
    us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-southeast-2|ap-northeast-1|ca-central-1|eu
    -central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1] [--lightsail-availability-zone <value>] [--id <value>] [-f
    <value>] [-p <value>] [-t <value>] [--tls-hostname <value>] [--insecure-skip-verify] [--columns <value> | -x]
    [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -d, --driver=<option>                  [default: lightsail] Machine driver to use
                                         <options: lightsail|fake>
  -f, --file=<value>...                  [default: ] Compose configuration file
  -p, --project=<value>                  Project name. Defaults to the Compose project name
  -t, --tunnel-url=<value>               [default: ssh+tls://livecycle.run] Tunnel url, specify ssh://hostname[:port] or
                                         ssh+tls://hostname[:port]
  -x, --extended                         show extra columns
  --columns=<value>                      only show provided columns (comma-separated)
  --csv                                  output is csv format [alias: --output=csv]
  --filter=<value>                       filter property by partial string matching, ex: name=foo
  --id=<value>                           Environment id - affects created URLs. If not specified, will try to detect
                                         automatically
  --insecure-skip-verify                 Skip TLS or SSH certificate verification
  --lightsail-availability-zone=<value>  AWS availability zone to provision resources in region
  --lightsail-region=<option>            AWS region to provision resources in
                                         <options: us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-
                                         1|ap-southeast-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|e
                                         u-west-3|eu-north-1>
  --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)
  --tls-hostname=<value>                 Override TLS server name when tunneling via HTTPS

GLOBAL FLAGS
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|info|warn|error>

DESCRIPTION
  Bring up a preview environment

See code: dist/commands/up/index.ts

preview urls [SERVICE] [PORT]

Show urls for an existing environment

USAGE
  $ preview urls [SERVICE] [PORT] [--log-level debug|info|warn|error] [-d lightsail|fake]
    [--lightsail-region us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-1|ap-southeast-2|ap-northea
    st-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1] [--lightsail-availability-zone <value>]
    [--id <value>] [-f <value>] [-p <value>] [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
    csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ] [--json]

ARGUMENTS
  SERVICE  Service name. If not specified, will show all services
  PORT     Service port. If not specified, will show all ports for the specified service

FLAGS
  -d, --driver=<option>                  [default: lightsail] Machine driver to use
                                         <options: lightsail|fake>
  -f, --file=<value>...                  [default: ] Compose configuration file
  -p, --project=<value>                  Project name. Defaults to the Compose project name
  -x, --extended                         show extra columns
  --columns=<value>                      only show provided columns (comma-separated)
  --csv                                  output is csv format [alias: --output=csv]
  --filter=<value>                       filter property by partial string matching, ex: name=foo
  --id=<value>                           Environment id - affects created URLs. If not specified, will try to detect
                                         automatically
  --lightsail-availability-zone=<value>  AWS availability zone to provision resources in region
  --lightsail-region=<option>            AWS region to provision resources in
                                         <options: us-east-2|us-east-1|us-west-2|ap-south-1|ap-northeast-2|ap-southeast-
                                         1|ap-southeast-2|ap-northeast-1|ca-central-1|eu-central-1|eu-west-1|eu-west-2|e
                                         u-west-3|eu-north-1>
  --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)

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|info|warn|error>

DESCRIPTION
  Show urls for an existing environment

See code: dist/commands/urls.ts

Keywords

preview

FAQs

Package last updated on 19 Mar 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Malicious Chrome Extension Exfiltrates Seed Phrases, Enabling Wallet Takeover

Research

/

Security News

Malicious Chrome Extension Exfiltrates Seed Phrases, Enabling Wallet Takeover

A malicious Chrome extension posing as an Ethereum wallet steals seed phrases by encoding them into Sui transactions, enabling full wallet takeover.

By Kirill Boychenko  -  Nov 12, 2025