@vivliostyle/cli

Supercharge your command-line publication workflow.

✏️ You want README for the stable release? see https://github.com/vivliostyle/vivliostyle-cli/tree/v2.1.0#readme.

Install

npm install -g @vivliostyle/cli

If you are yolo-minded person, try npm install -g @vivliostyle/cli@next, which will installs the latest pre-release of Vivliostyle CLI.

Use

Usage: vivliostyle [options] [command]

Options:
  -v, --version   output the version number
  -h, --help      display help for command

Commands:
  init            create vivliostyle config
  build           build and create PDF file
  preview         launch preview server
  help [command]  display help for command

init

create vivliostyle config file.

vivliostyle init

You are new to Vivliostyle? Check out our latest project Create Book. With Create Book, you can easily bootstrap your book project and start writing without any extra effort.

build

build and create PDF file.

Put vivliostyle.config.js in the root directory, then:

vivliostyle build

CLI options

Options:
  -c, --config <config_file>        path to vivliostyle.config.js [vivliostyle.config.js]
  -o, --out-file <output file>      specify output file path [<title>.pdf]
  -d, --out-dir <output directory>  specify output directory
  -t, --theme <theme>               theme path or package name
  -s, --size <size>                 output pdf size [Letter]
                                    preset: A5, A4, A3, B5, B4, JIS-B5, JIS-B4, letter, legal,
                                    ledger
                                    custom(comma separated): 182mm,257mm or 8.5in,11in
  -p, --press-ready                 make generated PDF compatible with press ready PDF/X-1a
                                    [false]
  --title <title>                   title
  --author <author>                 author
  --language <language>             language
  --verbose                         verbose log output
  --dist-dir                        dist dir [.vivliostyle]
  --timeout <seconds>               timeout limit for waiting Vivliostyle process [60s]
  --no-sandbox                      launch chrome without sandbox. use this option when
                                    ECONNREFUSED error occurred.
  --executable-chromium <path>      specify a path of executable Chrome (or Chromium) you
                                    installed
  -h, --help                        display help for command

preview

open preview page and save PDF interactively.

vivliostyle preview <input>

CLI options

Options:
  -c, --config <config_file>    path to vivliostyle.config.js
  -t, --theme <theme>           theme path or package name
  -s, --size <size>             output pdf size [Letter]
                                preset: A5, A4, A3, B5, B4, JIS-B5, JIS-B4, letter, legal,
                                ledger
                                custom(comma separated): 182mm,257mm or 8.5in,11in
  --title <title>               title
  --author <author>             author
  --language <language>         language
  --verbose                     verbose log output
  --no-sandbox                  launch chrome without sandbox (use this option to avoid
                                ECONNREFUSED error)
  --executable-chromium <path>  specify a path of executable Chrome(Chromium) you installed
  -h, --help                    display help for command

Q&A

Not working in Node v14.0.0

puppeteer is not working in Node v14.0.0, ie vivliostyle-cli is not working same. See also: https://developers.google.com/web/tools/puppeteer/troubleshooting

The error has been resolved by Node >= v14.1.0 or <= v12.0.0.

Contribute

See Contribution Guide.

License

Licensed under AGPL Version 3.

Changelog

3.0.0-pre.5 (2020-12-30)

Bug Fixes

• --language,--size, --theme options for init command is not working. (6feec71)
• include yarn.lock (605897e)
• remove .posix and update upath 2.0.1 (594b8dd)
• toc test fails due to separator on Windows (6a4ab12)

Features

• init command document to 3.0.0 specification (32906ef)
• init command to 3.0.0 specification (cf30818)