Reference Documentation
Technical specifications and reference material for the Dossier project.
Core Specifications
- Protocol - The dossier file format and verification protocol
- Schema - Dossier metadata schema and validation rules
- Specification - Complete formal specification
API & CLI Reference
- Core API Reference -
@ai-dossier/corelibrary API documentation - Capability Manifest -
.dossier/automation/manifest.yamlspec and thecapcommand - CLI Reference - Command-line tool options and usage
File Formats
- Dossier files (
.ds.md) - Markdown with JSON frontmatter - Working files (
.dsw.md) - Mutable execution state - Signature formats - Ed25519 and AWS KMS signatures
- Plan artifacts (
plan:v1) - Canonical per-issue plan comments
Standards & Compliance
- Security standards
- Cryptographic requirements
- Version compatibility
For Developers
- Implementing a verifier: See Protocol
- Parsing dossiers: Check the Schema
- Integration: Review Specification
Rendered from docs/reference/README.md in the repository. Edit it there.