Have ideas to improve npm?Join in the discussion! »

    @vivliostyle/cli
    TypeScript icon, indicating that this package has built-in type declarations

    3.4.0 • Public • Published

    Vivliostyle CLI

    npm npm: version (tag) npm: total downloads

    Supercharge your command-line publication workflow.

    Install

    npm install -g @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.

    CLI Options

    Options:
      --title <title>            title
      --author <author>          author
      -l, --language <language>  language
      -s, --size  <size>         paper size
      -T, --theme <theme>        theme
      -h, --help                 display help for command
    

    build

    build and create PDF file.

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

    vivliostyle build

    build

    CLI options

    Options:
      -c, --config <config_file>    path to vivliostyle.config.js [vivliostyle.config.js]
      -o, --output <path>           specify output file name or directory [<title>.pdf]
                                    This option can be specified multiple, then each -o options can be supplied one -f option.
                                    ex: -o output1 -f webpub -o output2.pdf -f pdf
      -f, --format <format>         specify output format corresponding output target
                                    If an extension is specified on -o option, this field will be inferenced automatically.
      -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]
      -t, --timeout <seconds>       timeout limit for waiting Vivliostyle process [60s]
      -T, --theme <theme>           theme path or package name
      --title <title>               title
      --author <author>             author
      -l, --language <language>     language
      --verbose                     verbose log output
      --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

    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
      -l, --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.

    Keywords

    Install

    npm i @vivliostyle/cli

    DownloadsWeekly Downloads

    171

    Version

    3.4.0

    License

    AGPL-3.0

    Unpacked Size

    280 kB

    Total Files

    110

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar