1. Introduction
  3. User Guide
  4. 1. Installation
  5. 2. Get Started
  6. 3. Frequently Asked Questions
  7. 4. Further reading
  9. Reference Guide
  10. 5. Command Line Tool
    1. 5.1. init
    2. 5.2. build
    3. 5.3. serve
    4. 5.4. clean
    5. 5.5. completions
  12. 6. Format
    1. 6.1. book.typ
      1. 6.1.1. Book Metadata
        1. 6.1.1.1. Draft chapter
      3. 6.1.2. Build Metadata
    3. 6.2. Theme
    4. 6.3. Typst Support
      1. 6.3.1. Cross Reference
        1. 6.3.1.1. Cross Reference Sample
      3. 6.3.2. Embed Sanitized HTML Elements
        1. 6.3.2.1. Multimedia components
      5. 6.3.3. Semantic Page Description
    6. 6.4. Rendering Tests
  14. 7. For developers
    1. 7.1. Typst-side APIs
    2. 7.2. shiroa CLI Internals
    3. 7.3. Alternative Backends

shiroa

#

Command Line Tool

The shiroa command-line tool is used to create and build books. After you have installed shiroa, you can run the shiroa help command in your terminal to view the available commands.

This following sections provide in-depth information on the different commands available.

  • shiroa init <directory> — Creates a new book with minimal boilerplate to start with.
  • shiroa build — Renders the book.
  • shiroa serve — Runs a web server to view the book, and rebuilds on changes.
  • shiroa clean — Deletes the rendered output.
  • shiroa completions — Support for shell auto-completion.

#

Note about the missing watch command

We suggest you to use Typst Preview plugin for preview feature. For more details, please see Get Started chapter.