Skip to content

CLI

Modified at Nov 16, 2026
DescriptionReference for the typerighter CLI: init, setup-editor, dev, build, preview, and check commands with all options.

The typerighter CLI handles project scaffolding, editor setup, development, and production builds:

  • typerighter init - scaffold a new project

  • typerighter setup-editor - configure your editor for Typedown

  • typerighter dev - start the dev server with hot reload

  • typerighter build - generate the static site

  • typerighter preview - preview the built site locally

  • typerighter check - run type checking and linting without building

typerighter init ​

Scaffold a new Typedown project. Creates a typedown.yaml config and a vault/ directory with a starter index.td.

Bash
typerighter init [root]
  • root: project directory (defaults to the current directory)

typerighter setup-editor ​

Detect installed editors and configure them for Typedown. Sets up the LSP server, tree-sitter grammars, and file type detection.

Bash
typerighter setup-editor [editor]
  • editor: neovim, vscode, or zed. If omitted, detects installed editors and prompts which to set up.

For Neovim, adds the plugin configuration to your plugin manager.

For VS Code, downloads and installs the .vsix extension.

For Zed, opens the extension marketplace.

See Editor setup for manual instructions.

typerighter dev ​

Start a development server with hot module replacement.

Bash
typerighter dev [root]
  • root: project directory (defaults to the current directory)

  • --port <port>: port to listen on (defaults to 8686)

  • --host: expose the server to the network

typerighter build ​

Build the site for production. Outputs static HTML, CSS, and JS to the output directory.

Bash
typerighter build [root]
  • root: project directory (defaults to the current directory)

  • --outDir <dir>: output directory (defaults to dist)

  • --base <path>: base public path (defaults to /)

typerighter preview ​

Preview the production build locally.

Bash
typerighter preview [root]
  • root: project directory (defaults to the current directory)

  • --port <port>: port to listen on

typerighter check ​

Check the vault for type errors, unresolved references, and lint warnings. Exits with code 1 if there are errors.

Bash
typerighter check [root]
  • root: project directory (defaults to the current directory)

  • --fix: auto-fix formatting issues

Edit this page