Livecycle CLI - Link your preview environment to livecycle
Usage
$ npm install -g @livecycle/cli
$ livecycle COMMAND
running command...
$ livecycle (--version)
@livecycle/cli/0.1.11 darwin-arm64 node-v16.20.0
$ livecycle --help [COMMAND]
USAGE
$ livecycle COMMAND
...Commands
livecycle help [COMMAND]
Display help for livecycle.
USAGE
$ livecycle 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 livecycle.
See code: @oclif/plugin-help
livecycle link
Link a url to livecycle document
USAGE
$ livecycle link --api-key <value> --url <value> [--from-git <value>] [-d <value>] [--ref <value>]
[--revision <value>] [--revision-timestamp <value>] [--author-email <value>] [--author-name <value>]
[--author-avatar <value>] [--logs-url <value>] [--status done|progress|error]
FLAGS
-d, --description=<value> (required when not using git context) Description of the preview env
--api-key=<value> (required) API key for the service, can be generated by accessing user settings at
https://livecycle.dev
--author-avatar=<value> Author avatar url
--author-email=<value> (required when not using git context) Author email of the preview env
--author-name=<value> (required when not using git context) Author name of the preview env
--from-git=<value> Infer whatever fields possible from git, value is the base directory to be used
--logs-url=<value> Url to the build logs
--ref=<value> (required when not using git context) Project ref - used to group playgrounds
Example: git://provider/owner/repo#branch
project://projectName#arbitraryDocumentName
--revision=<value> (required when not using git context) Revision of the preview env
--revision-timestamp=<value> (required when not using git context) Revision timestamp of the preview env
--status=<option> Status of the preview environment
<options: done|progress|error>
--url=<value> (required) Url to be linked to the document
DESCRIPTION
Link a url to livecycle document
EXAMPLES
$ livecycle link --api-key DEh4uk0t.MCBGhR_pC --url https://yourawesomesite.com --from-git .
Document linked to url succesfuly