Need help with pug-cli?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

pugjs
228 Stars 55 Forks MIT License 69 Commits 45 Opened issues

Description

Pug's CLI interface

Services available

!
?

Need anything else?

Contributors list

pug-cli

Pug's CLI interface

Build Status Dependency Status NPM version Coverage Status

Usage

$ pug [options] [dir|file ...]

Render

s and all files in 
s. If no files are specified, input is taken from standard input and output to standard output.

Options

-h, --help             output usage information
-V, --version          output the version number
-O, --obj    JSON/JavaScript options object or file
-o, --out         output the rendered HTML or compiled JavaScript to
                       
-p, --path       filename used to resolve includes
-b, --basedir          path used as root directory to resolve absolute includes
-P, --pretty           compile pretty HTML output
-c, --client           compile function for client-side runtime.js
-n, --name        the name of the compiled template (requires --client)
-D, --no-debug         compile without debugging (smaller functions)
-w, --watch            watch files for changes and automatically re-render
-E, --extension   specify the output file extension
-s, --silent           do not output logs
--name-after-file      name the template after the last section of the file
                       path (requires --client and overriden by --name)
--doctype         specify the doctype on the command line (useful if it
                       is not specified by the template)


Examples

Render all files in the

templates
directory:
$ pug templates

Create

{foo,bar}.html
:
$ pug {foo,bar}.pug

Using

pug
over standard input and output streams:
$ pug < my.pug > my.html
$ echo "h1 Pug!" | pug

Render all files in

foo
and
bar
directories to
/tmp
:
$ pug foo bar --out /tmp

Specify options through a string:

$ pug -O '{"doctype": "html"}' foo.pug
# or, using JavaScript instead of JSON
$ pug -O "{doctype: 'html'}" foo.pug

Specify options through a file:

$ echo "exports.doctype = 'html';" > options.js
$ pug -O options.js foo.pug
# or, JSON works too
$ echo '{"doctype": "html"}' > options.json
$ pug -O options.json foo.pug

Installation

npm install pug-cli -g

License

MIT

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.