Guides

This section contains best practices, troubleshooting guides, and advanced usage documentation for Calvin.

Available Guides

Core Concepts

Guide	Description
Scope and Deploy Target	Understanding deployment scopes and targets
Configuration	Environment variables and config.toml settings

Advanced Features

Guide	Description
Multi-Layer PromptPacks	Share assets across projects with layered configurations
Skills	Directory-based `SKILL.md` assets (Claude Code, Cursor, Codex)
Clean Command	Remove deployed files safely and efficiently

Quick Tips

Choosing the Right Scope

Use scope: project for team-shared rules and project-specific configurations
Use scope: user for personal preferences and global workflows

Common Workflows

# Deploy to project (default)
calvin deploy

# Deploy to home directory
calvin deploy --home

# Preview changes before deploying
calvin diff

# Watch for changes and auto-deploy
calvin watch

# Check configuration for issues
calvin check

# Clean deployed files (interactive)
calvin clean

# Clean all home deployments
calvin clean --home --yes

Troubleshooting

If you encounter issues:

Run calvin check to validate your configuration
Use calvin diff to preview what would change
Check the Pitfall Mitigations guide for common issues

Guides

On this page