CLI
The typerighter CLI handles project scaffolding, editor setup, development, and production builds:
typerighter init- scaffold a new projecttyperighter setup-editor- configure your editor for Typedowntyperighter dev- start the dev server with hot reloadtyperighter build- generate the static sitetyperighter preview- preview the built site locallytyperighter 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.
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.
typerighter setup-editor [editor]editor:neovim,vscode, orzed. 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.
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.
typerighter build [root]root: project directory (defaults to the current directory)--outDir <dir>: output directory (defaults todist)--base <path>: base public path (defaults to/)
typerighter preview
Preview the production build locally.
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.
typerighter check [root]root: project directory (defaults to the current directory)--fix: auto-fix formatting issues