Nihilist Postmodern Mistake
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

livingdocs-cli

1.3.1 • Public • Published

livingdocs-cli

Livingdocs Command Line Interface

oclif Version Codecov Downloads/week License

Usage

$ npm install -g livingdocs-cli
$ livingdocs-cli COMMAND
running command...
$ livingdocs-cli (-v|--version|version)
livingdocs-cli/0.0.0 darwin-x64 node-v12.10.0
$ livingdocs-cli --help [COMMAND]
USAGE
  $ livingdocs-cli COMMAND
...

Commands

livingdocs-cli cli-config:print

Print current CLI configuration

USAGE
  $ livingdocs-cli cli-config:print

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

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 design-server:start

Start a design server for development

USAGE
  $ livingdocs-cli design-server:start

OPTIONS
  -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.
  --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.

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

  -t, --token=token         (required) The Access Token to your project (needs write 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:drafts

List project configuration drafts

USAGE
  $ livingdocs-cli project-config:drafts

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

  -t, --token=token  (required) The Access Token to your project (needs write permission).
                     Can be set by the environment variable 'LI_TOKEN'.

See code: src/commands/project-config/drafts.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 or filename where to download to.

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

  -t, --token=token  (required) The Access Token to your project (needs 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 ChannelConfig to your project

USAGE
  $ livingdocs-cli project-config:publish

OPTIONS
  -d, --dist=dist    The folder to publish from.

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

  -t, --token=token  (required) The Access Token to your project (needs write permission).
                     Can be set by the environment variable 'LI_TOKEN'.

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

livingdocs-cli project-config:upload

Upload a ChannelConfig into a draft for your project

USAGE
  $ livingdocs-cli project-config:upload

OPTIONS
  -d, --dist=dist        The folder or filename where to download to.

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

  -t, --token=token      (required) The Access Token to your project (needs write permission).
                         Can be set by the environment variable 'LI_TOKEN'.

  --draftName=draftName  (required) The name of the draft the config will be saved under.

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

livingdocs-cli project-config:upload_assets

Upload assets to your project

USAGE
  $ livingdocs-cli project-config:upload_assets

OPTIONS
  -a, --assets=assets  The folder where you asset files are located.

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

  -t, --token=token    (required) The Access Token to your project (needs write permission).
                       Can be set by the environment variable 'LI_TOKEN'.

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

Keywords

Install

npm i livingdocs-cli

DownloadsWeekly Downloads

34

Version

1.3.1

License

MIT

Unpacked Size

364 kB

Total Files

36

Last publish

Collaborators

  • avatar