Learn how to start and preview projects, output files, and more
Quire commands are typically run from Terminal on a Mac and PowerShell on a PC. They control creating, previewing, and outputting Quire projects. The following commands are available.
quire --helpin your command-line shell for a full list of the Quire commands and options defined below.
Start and Preview Projects
|Create a new Quire project with the default starter content||The command must include a project name, for example |
|Build and serve the Quire site in development mode||This command enables you to preview your project at the default URL http://localhost:8080/. If there are errors in your project, messaging will appear in your command-line shell that point you to issues in your Markdown or YAML.|
npm installto install Quire’s dependencies when you clone a project and preview it for the first time. This command only needs to be run once in a project.
|Build project site files used to generate the various outputs||This creates the site files for the HTML format of the project. These site files are then used to create the PDF or EPUB versions of the project. This is therefore a necessary step before running the commands |
|Build Quire project in PDF format||You must run |
|Build Quire project in EPUB format||You must run |
|Remove old build outputs||This command is distinct from the quire/11ty package script |
|List Quire version number||This is useful for troubleshooting and confirming updates.|
|Provide list of Quire commands||This is useful if you need a reminder of commands.|
|List ||This command must be run while in a Quire project directory.|
|Include node, npm, and OS version numbers in addition to ||This command must be run while in a Quire project directory.|
Not Yet Implemented
These commands are not yet available but are currently under development.
|Edit the Quire CLI configuration|
|Preview your Quire publication as a PDF|
|Preview your Quire publication as an EPUB|
|Start a local web server to serve a previously built Quire site|
|Set the Quire version you want to use when running commands||For example, |
|Clone an existing Quire project from a git repository|
Helpful Non-Quire commands
|Used to change project directories||You will use this command to navigate into your Quire project directory. Once you are in the directory you can run commands like |
|Will take you back one directory level||This is especially useful if you keep multiple Quire projects as sub-directories within a main directory.|
|Used to list all the files when in a project directory||This can be useful in making sure you are in the right folder.|
|This will re-run the last command you entered|
- The key combo
Control-Ccan be used to stop the preview of a Quire project. Stopping and restarting the Quire preview is helpful for troubleshooting.