livingdocs-cli

livingdocs-cli

Livingdocs Command Line Interface

Setup

npm install -g livingdocs-cli
livingdocs-cli --help

Documentation

Livingdocs CLI documentation

Commands Reference

• livingdocs-cli component-library:build
• livingdocs-cli config:print
• livingdocs-cli design-server:start
• livingdocs-cli help [COMMAND]
• livingdocs-cli project-config:download
• livingdocs-cli project-config:import-design
• livingdocs-cli project-config:plan
• livingdocs-cli project-config:publish
• livingdocs-cli project-config:publish-design
• livingdocs-cli project-config:upload-assets

livingdocs-cli component-library:build

Build a Component Library JSON file

USAGE
  $ livingdocs-cli component-library:build

OPTIONS
  -d, --dist=dist  The folder where the output will be written.
  -s, --src=src    The folder with your .html component templates

See code: src/commands/component-library/build.js

livingdocs-cli config:print

Print current CLI configuration

USAGE
  $ livingdocs-cli config:print

OPTIONS
  -e, --env=env          If used configuration options are loaded from .livingdocs-cli file.
  -p, --project=project  If used configuration options are loaded from .livingdocs-cli file.

See code: src/commands/config/print.js

livingdocs-cli design-server:start

Start a design server for development

USAGE
  $ livingdocs-cli design-server:start

OPTIONS
  -a, --address=address  The address of the design-server.
  -d, --dist=dist        (required) The folder to load designs from.
  -p, --port=port        [default: 9030] The port of the design-server.
  --assets=assets        Asset folder to serve static files.
  --basePath=basePath    The basePath to set in `assets.basePath`.
  --verbose

See code: src/commands/design-server/start.js

livingdocs-cli help [COMMAND]

display help for livingdocs-cli

USAGE
  $ livingdocs-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

livingdocs-cli project-config:download

Download a project configuration

USAGE
  $ livingdocs-cli project-config:download

OPTIONS
  -d, --dist=dist           The folder where the output will be written.
  -e, --env=env             If used configuration options are loaded from .livingdocs-cli file.

  -h, --host=host           (required) [default: http://localhost:9090] The livingdocs host.
                            Can be set by the environment variable 'LI_HOST'.

  -p, --project=project     If used configuration options are loaded from .livingdocs-cli file.

  -t, --token=token         (required) Access Token for your project (needs `public-api:config:read` permission).
                            Can be set by the environment variable 'LI_TOKEN'.

  --format=js|js/html|json  The format of the files written.

See code: src/commands/project-config/download.js

livingdocs-cli project-config:import-design

Import a design into a given project configuration

USAGE
  $ livingdocs-cli project-config:import-design

OPTIONS
  -d, --dist=dist            (required) The folder where the output will be written.
  -e, --env=env              If used configuration options are loaded from .livingdocs-cli file.
  -p, --project=project      If used configuration options are loaded from .livingdocs-cli file.
  -u, --designUri=designUri  (required) URL of the design to import

See code: src/commands/project-config/import-design.js

livingdocs-cli project-config:plan

See what would be updated in a publish command

USAGE
  $ livingdocs-cli project-config:plan

OPTIONS
  -d, --dist=dist        The folder where the output will be written.
  -e, --env=env          If used configuration options are loaded from .livingdocs-cli file.

  -h, --host=host        (required) [default: http://localhost:9090] The livingdocs host.
                         Can be set by the environment variable 'LI_HOST'.

  -p, --project=project  If used configuration options are loaded from .livingdocs-cli file.

  -s, --source=source    The folder or filename to the project config.

  -t, --token=token      (required) Access Token for your project (needs `public-api:config:write` permission).
                         Can be set by the environment variable 'LI_TOKEN'.

See code: src/commands/project-config/plan.js

livingdocs-cli project-config:publish

Publish a project configuration to your project

USAGE
  $ livingdocs-cli project-config:publish

OPTIONS
  -d, --dist=dist        The folder where the output will be written.
  -e, --env=env          If used configuration options are loaded from .livingdocs-cli file.

  -h, --host=host        (required) [default: http://localhost:9090] The livingdocs host.
                         Can be set by the environment variable 'LI_HOST'.

  -p, --project=project  If used configuration options are loaded from .livingdocs-cli file.

  -s, --source=source    The folder or filename to the project config.

  -t, --token=token      (required) Access Token for your project (needs `public-api:config:write` permission).
                         Can be set by the environment variable 'LI_TOKEN'.

  -y, --yes              Confirm

See code: src/commands/project-config/publish.js

livingdocs-cli project-config:publish-design

Publish Design to DesignServer

USAGE
  $ livingdocs-cli project-config:publish-design

OPTIONS
  -d, --dist=dist          (required) The folder to the design.
  -f, --forceUpdate        The design name of the assets to upload

  -h, --host=host          (required) [default: http://localhost:9090] The livingdocs host.
                           Can be set by the environment variable 'LI_HOST'.

  -p, --password=password  password for login

  -u, --username=username  username for login

See code: src/commands/project-config/publish-design.js

livingdocs-cli project-config:upload-assets

Upload assets to your design

USAGE
  $ livingdocs-cli project-config:upload-assets

OPTIONS
  -a, --assets=assets                The folder where you asset files are located.
  -d, --designName=designName        The design name of the assets to upload
  -d, --designVersion=designVersion  The design version of the assets to upload

  -h, --host=host                    [default: http://localhost:9090] The livingdocs host.
                                     Can be set by the environment variable 'LI_HOST'.

  -t, --token=token                  (required) Access Token for your project (needs `public-api:config:write`
                                     permission).
                                     Can be set by the environment variable 'LI_TOKEN'.

See code: src/commands/project-config/upload-assets.js