Documentation · Dossiers

Installation

Install the Dossiers CLI using Cargo or npm and get started in minutes.

Learn how to organize your specification files and assets.

Understand the metadata fields Dossiers supports and how to use them.

Configure custom metadata fields and project settings.

Publish your generated site to GitHub Pages, Netlify, or your own server.

cargo install dossiers

mkdir specs
cat > specs/0001-example.md << 'EOF'
---
created: 2025-01-15
status: Draft
---

# Example Specification

This is my first spec!
EOF

dossiers serve ./specs

Open http://localhost:8080 in your browser!

If you have questions or run into issues, we're happy to help.