npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

livingdocs-cli

v5.6.42

Published

Livingdocs Command Line Utility

Downloads

1,300

Readme

oclif Version Downloads/week License

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

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