Getting Started with Dossier
Welcome! A dossier is a skill โ a reusable instruction set an AI executes โ with trust, versioning, and cross-tool portability built in. This guide gets you running one, then authoring your own.
Recommended Learning Path
- Try it (2 min) โ Copy the Hello World example into any LLM chat
- Install the CLI (2 min) โ
npm install -g @ai-dossier/cli - Your first dossier (10 min) โ Follow the tutorial
- Browse examples (5 min) โ Explore real-world dossiers
- Go deeper โ Read the Dossier Guide for concepts, schema, and security
Installation
# Install globally
npm install -g @ai-dossier/cli
# Or use without installing
npx @ai-dossier/cli verify <dossier-file>
For MCP server integration, registry configuration, and authentication details, see installation.md.
Verify Your First Dossier
ai-dossier verify https://raw.githubusercontent.com/imboard-ai/ai-dossier/main/examples/devops/deploy-to-aws.ds.md
Next Steps
- Create your first dossier โ Step-by-step tutorial
- Learn about the protocol โ How dossiers are verified and run
- Explore example dossiers โ Real-world templates
- Understand security model โ Checksums, signatures, risk levels
Need Help?
- Check the FAQ โ Covers common questions and comparisons
- Browse guides for specific tasks
- Ask questions in GitHub Discussions
Rendered from docs/getting-started/README.md in the repository. Edit it there.