deciduous
AGENTS.md171 starsChanged 23 days agoApache-2.0View on GitHub
This file was converted from CLAUDE.md. OpenCode uses AGENTS.md for project instructions. See: https://opencode.ai/docs/rules/ Decision graph tooling for AI-assisted development. Track every goal, decision, and outcome. Survive context loss. Query your reasoning. Every system has two stories: Now mode maps current design as decisions. History mode captures evolution and pivots. Take the pulse of a system - what decisions define how it works TODAY. Output: Decision tree of the current model (goal -> options -> decisions). Understand how the system…
- Reads credentials
- Installs packages
- Commits and pushes
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 32,671 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository3 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- docs/llms-full.txtllms.txt
- docs/llms.txtllms.txt
The file
Show its rules and text
We split this AGENTS.md into the rules it gives an agent
19 rules. About 0 are common, 10 are distinctive, and 9 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈10
Distinctive · estimate
This author's own choices. Worth a look.
9
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 14
Every system has two stories:
- Distinctive: line 49
Look at the current system
- Distinctive: line 50
Ask "how did this get this way?"
- Very specific: line 75
All slash commands are bootstrapped by deciduous init and updated by deciduous update.
- Distinctive: line 93
When a design approach is abandoned and replaced:
- Very specific: line 258
Do NOT aggressively prompt for documents: Only suggest when files are directly relevant to a decision node.
- Distinctive: line 262
Prompts must be the EXACT user message, not a summary: When a user request triggers new work, capture their full message word-for-word.
- Very specific: line 423
Every new session or after context recovery, run /recover or:
- Very specific: line 469
When working on this project, identify which domain the work belongs to and use the appropriate subagent context.
- Distinctive: line 483
When spawning a Task for exploration or implementation:
- Very specific: line 547
After modifying any web/src/ files:
- Very specific: line 568
No artificial node limits (MAX_CHAIN_NODES = 0 means unlimited)
- Distinctive: line 657
Ask the user before any destructive operation
- Distinctive: line 689
Do NOT commit if tests fail.
- Distinctive: line 695
Do NOT commit code that doesn't compile.
- Distinctive: line 734
Only commit if ALL pass.
- Very specific: line 742
Follow semver strictly: MAJOR.MINOR.PATCH
- Very specific: line 877
If graphviz is not installed, deciduous dot --png will fail with a helpful error message.
- Very specific: line 883
When you run deciduous init, a GitHub workflow is created at .github/workflows/cleanup-decision-graphs.yml.
≈ “Common” is an estimate: at least 1 in 5 of the 41,581 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Project Instructions for OpenCode
This file was converted from CLAUDE.md. OpenCode uses AGENTS.md for project instructions. See: https://opencode.ai/docs/rules/
Deciduous - Decision Graph Tooling
Decision graph tooling for AI-assisted development. Track every goal, decision, and outcome. Survive context loss. Query your reasoning.
The Two Modes
Every system has two stories:
| Mode | Question | Skill |
| Now | "How does this work?" | /pulse |
| History | "How did we get here?" | /narratives → /archaeology |
Now mode maps current design as decisions. History mode captures evolution and pivots.
Skills Overview
/pulse - Map Current Design
Take the pulse of a system - what decisions define how it works TODAY.
# Start with a goal
deciduous add goal "API rate limiting behavior" -c 90
# Map options (possible approaches from the goal)
deciduous add option "Identify users by auth token" -c 85
deciduous link 1 2 -r "possible_approach"
deciduous add option "Use IP-based rate limiting" -c 85
deciduous link 1 3 -r "possible_approach"Output: Decision tree of the current model (goal -> options -> decisions).
/narratives - Understand Evolution
Understand how the system evolved. Narratives are conceptual, not tied to commits.
- Look at the current system
- Ask "how did this get this way?"
- Infer narratives from the design
- Find evidence (commits, PRs, docs)
- Identify pivots - where the model changed
Output: .deciduous/narratives.md with evolution stories.
/archaeology - Structure for Query
Transform narratives into a queryable graph.
| Narrative Element | Graph Node |
| Title | goal |
| Possible approach | option |
| Choosing an approach | decision |
| What was learned | observation |
| PIVOT | revisit |
Output: Connected graph with Now ← revisit ← History.
Slash Commands
All slash commands are bootstrapped by deciduous init and updated by deciduous update.
| Command | Purpose |
/decision | Manage decision graph - add nodes, link edges, sync |
/recover | Recover context from decision graph on session start |
/work | Start a work transaction - creates goal node before implementation |
/document | Generate comprehensive documentation for a file or directory |
/build-test | Build the project and run the test suite |
/serve-ui | Start the decision graph web viewer |
/sync-graph | Export decision graph to GitHub Pages |
/decision-graph | Build a decision graph from commit history (archaeology) |
/sync | Multi-user sync - reconcile .deciduous/graph.json with the local database |
The Revisit Node
When a design approach is abandoned and replaced:
[Old Decision] ──► [Observation: why it failed] ──► [REVISIT] ──► [New Decision]The revisit captures:
- WHAT is being reconsidered
- WHY (linked observations)
- Connects old approach to new
deciduous add observation "JWT too large for mobile"
deciduous add revisit "Reconsidering token strategy"
deciduous link <observation> <revisit> -r "forced rethinking"
deciduous status <old_decision> supersededNode Status
| Status | Meaning |
active | Current truth |
superseded | Replaced by newer approach |
abandoned | Tried and rejected |
# Now mode - only active
deciduous nodes --status active
# History mode - everything
deciduous nodes
# Pivot points
deciduous nodes --type revisit<!-- deciduous:start -->Decision Graph Workflow
THIS IS MANDATORY. Log decisions IN REAL-TIME, not retroactively.
Available Slash Commands
| Command | Purpose |
/decision | Manage decision graph - add nodes, link edges, sync |
/recover | Recover context from decision graph on session start |
/work | Start a work transaction - creates goal node before implementation |
/document | Generate comprehensive documentation for a file or directory |
/build-test | Build the project and run the test suite |
/serve-ui | Start the decision graph web viewer |
/sync-graph | Export decision graph to GitHub Pages |
/decision-graph | Build a decision graph from commit history |
/sync | Multi-user sync - reconcile .deciduous/graph.json with the local database |
Available Skills
| Skill | Purpose |
/pulse | Map current design as decisions (Now mode) |
/narratives | Understand how the system evolved (History mode) |
/archaeology | Transform narratives into queryable graph |
The Node Flow Rule - CRITICAL
The canonical flow through the decision graph is:
goal -> options -> decision -> actions -> outcomes- Goals lead to options (possible approaches to explore)
- Options lead to a decision (choosing which option to pursue)
- Decisions lead to actions (implementing the chosen approach)
- Actions lead to outcomes (results of the implementation)
- Observations attach anywhere relevant
- Goals do NOT lead directly to decisions -- there must be options first
- Options do NOT come after decisions -- options come BEFORE decisions
- Decision nodes should only be created when an option is actually chosen, not prematurely
The Core Rule
BEFORE you do something -> Log what you're ABOUT to do
AFTER it succeeds/fails -> Log the outcome
CONNECT immediately -> Link every node to its parent
AUDIT regularly -> Check for missing connectionsBehavioral Triggers - MUST LOG WHEN:
| Trigger | Log Type | Example |
| User asks for a new feature | goal with -p | "Add dark mode" |
| Exploring possible approaches | option | "Use Redux for state" |
| Choosing between approaches | decision | "Choose state management" |
| About to write/edit code | action | "Implementing Redux store" |
| Something worked or failed | outcome | "Redux integration successful" |
| Notice something interesting | observation | "Existing code uses hooks" |
| Work lands, is dropped, or is replaced | status | deciduous status 12 completed |
Close What You Open
A node that is never closed is listed as open for good. Set its status in the same turn as the work, the way you link a node in the same turn you create it.
| Status | Meaning |
pending | Not started. A goal, option, decision, action or revisit is born with it |
active | In flight now. Keep it to a handful |
completed | Done. An outcome or observation is born with it: they record what already happened |
rejected | An option not taken |
superseded | Replaced by a later node; link that node |
abandoned | Dropped without being done |
Open is pending or active. Everything else is closed.
deciduous nodes --open # what is still open (--status <s>, --json)
deciduous pulse # open goals, each with its open work
deciduous audit # what drifted: records left open, committed actions never closed, orphans
deciduous why src/db.rs # the decisions behind a file (or src/db.rs:120-180): what was chosen, what was rejectedEdge types say what a link means; leads_to is the fallback, not the answer to everything:
- option -> decision:
-t chosenor-t rejected - one thing waiting on another:
-t blocks; one thing making another possible:-t enables
Document Attachments
Attach files (images, PDFs, diagrams, specs, screenshots) to decision graph nodes for rich context.
# Attach a file to a node
deciduous doc attach <node_id> <file_path>
deciduous doc attach <node_id> <file_path> -d "Architecture diagram"
deciduous doc attach <node_id> <file_path> --ai-describe
# List documents
deciduous doc list # All documents
deciduous doc list <node_id> # Documents for a specific node
# Manage documents
deciduous doc show <doc_id> # Show document details
deciduous doc describe <doc_id> "Updated description"
deciduous doc describe <doc_id> --ai # AI-generate description
deciduous doc open <doc_id> # Open in default application
deciduous doc detach <doc_id> # Soft-delete (recoverable)
deciduous doc gc # Remove orphaned files from diskWhen to suggest document attachment:
| Situation | Action |
| User shares an image or screenshot | Ask: "Want me to attach this to the current goal/action node?" |
| User references an external document | Ask: "Should I attach a copy to the decision graph?" |
| Architecture diagram is discussed | Suggest attaching it to the relevant goal node |
| Files not in the project are dropped in | Attach to the most relevant active node |
Do NOT aggressively prompt for documents. Only suggest when files are directly relevant to a decision node. Files are stored in .deciduous/documents/ with content-hash naming for deduplication.
CRITICAL: Capture VERBATIM User Prompts
Prompts must be the EXACT user message, not a summary. When a user request triggers new work, capture their full message word-for-word.
BAD - summaries are useless for context recovery:
# DON'T DO THIS - this is a summary, not a prompt
deciduous add goal "Add auth" -p "User asked: add login to the app"GOOD - verbatim prompts enable full context recovery:
# Use --prompt-stdin for multi-line prompts
deciduous add goal "Add auth" -c 90 --prompt-stdin << 'EOF'
I need to add user authentication to the app. Users should be able to sign up
with email/password, and we need OAuth support for Google and GitHub. The auth
should use JWT tokens with refresh token rotation.
EOF
# Or use the prompt command to update existing nodes
deciduous prompt 42 << 'EOF'
The full verbatim user message goes here...
EOFWhen to capture prompts:
- Root
goalnodes: YES - the FULL original request - Major direction changes: YES - when user redirects the work
- Routine downstream nodes: NO - they inherit context via edges
Updating prompts on existing nodes:
deciduous prompt <node_id> "full verbatim prompt here"
cat prompt.txt | deciduous prompt <node_id> # Multi-line from stdinPrompts are viewable in the web viewer.
CRITICAL: Maintain Connections
The graph's value is in its CONNECTIONS, not just nodes.
| When you create... | IMMEDIATELY link to... |
outcome | The action that produced it |
action | The decision that spawned it |
decision | The option(s) it chose between |
option | Its parent goal |
observation | Related goal/action |
revisit | The decision/outcome being reconsidered |
Root goal nodes are the ONLY valid orphans.
Quick Commands
deciduous add goal "Title" -c 90 -p "User's original request"
deciduous add action "Title" -c 85
deciduous link FROM TO -r "reason" # DO THIS IMMEDIATELY!
deciduous serve # View live (auto-refreshes every 30s)
deciduous sync # Export for static hosting
# Metadata flags
# -c, --confidence 0-100 Confidence level
# -p, --prompt "..." Store the user prompt (use when semantically meaningful)
# -f, --files "a.rs,b.rs" Associate files
# -b, --branch <name> Git branch (auto-detected)
# --commit <hash|HEAD> Link to git commit (use HEAD for current commit)
# --date "YYYY-MM-DD" Backdate node (for archaeology)
# Branch filtering
deciduous nodes --branch main
deciduous nodes -b feature-authCRITICAL: Link Commits to Actions/Outcomes
After every git commit, link it to the decision graph!
git commit -m "feat: add auth"
deciduous add action "Implemented auth" -c 90 --commit HEAD
deciduous link <goal_id> <action_id> -r "Implementation"The --commit HEAD flag captures the commit hash and links it to the node. The web viewer will show commit messages, authors, and dates.
Git History & Deployment
# Export graph AND git history for web viewer
deciduous sync
# This creates:
# - docs/graph-data.json (decision graph)
# - docs/git-history.json (commit info for linked nodes)To deploy to GitHub Pages:
deciduous syncto export- Push to GitHub
- Settings > Pages > Deploy from branch > /docs folder
Your graph will be live at https://<user>.github.io/<repo>/
Branch-Based Grouping
Nodes are auto-tagged with the current git branch. Configure in .deciduous/config.toml:
[branch]
main_branches = ["main", "master"]
auto_detect = trueAudit Checklist (Before Every Sync)
- Does every outcome link back to what caused it?
- Does every action link to why you did it?
- Any dangling outcomes without parents?
Git Staging Rules - CRITICAL
NEVER use broad git add commands that stage everything:
- ❌
git add -A- stages ALL changes including untracked files - ❌
git add .- stages everything in current directory - ❌
git add -aorgit commit -am- auto-stages all tracked changes - ❌
git add *- glob patterns can catch unintended files
ALWAYS stage files explicitly by name:
- ✅
git add src/main.rs src/lib.rs - ✅
git add Cargo.toml Cargo.lock - ✅
git add .opencode/commands/decision.md
Why this matters:
- Prevents accidentally committing sensitive files (.env, credentials)
- Prevents committing large binaries or build artifacts
- Forces you to review exactly what you're committing
- Catches unintended changes before they enter git history
Session Start Checklist
deciduous check-update # Update needed? Run 'deciduous update' if yes
deciduous nodes # What decisions exist?
deciduous edges # How are they connected? Any gaps?
deciduous doc list # Any attached documents to review?
git status # Current stateMulti-User Sync
The graph is shared through one file, .deciduous/graph.json, committed with the code. It is written automatically on every change.
deciduous sync # after git pull: import teammates' records, export yours
deciduous sync --check # what is pending? (exit 1 if anything)
git add .deciduous/graph.json # before git pushLocal node ids differ per machine. To link to a teammate's node, use its change_id prefix (the CHANGE column in deciduous nodes): deciduous link a1b2c3d4 <id> -r "...". Concurrent edits merge record by record through a git merge driver; if the file ever shows conflict markers, deciduous sync merges it.
<!-- deciduous:end -->Session Start Checklist
Every new session or after context recovery, run /recover or:
deciduous check-update # Update needed? Run 'deciduous update' if yes
deciduous nodes # What decisions exist?
deciduous edges # How are they connected?
deciduous commands # What happened recently?
git log --oneline -10 # Recent commits
git status # Current stateQuick Reference
# Build
cargo build --release
# Run tests
cargo test
# Initialize in a new project
deciduous init
# Update Claude integration files to latest version
deciduous update
# Start graph viewer
deciduous serve --port 3000
# Export graph
deciduous sync
deciduous graph > graph.json
# Generate DOT visualization
deciduous dot --png -o docs/decision-graph.dot
# Generate PR writeup
deciduous writeup -t "Feature X" --nodes 1-15 -o PR-WRITEUP.mdSubagents - Domain-Specific Context
Use subagents to scope work to specific parts of the codebase.
When working on this project, identify which domain the work belongs to and use the appropriate subagent context. Subagent definitions are in .opencode/agents.toml.
Available Subagents
| Agent | Domain | Key Files |
rust-core | CLI, database, export/sync | src/main.rs, src/db.rs, src/export.rs |
web | React/TypeScript viewer | web/src/**/*.{ts,tsx} |
tooling | OpenCode configuration | .opencode/, AGENTS.md, src/init/ |
docs | Documentation, guides | docs/, README.md, ROADMAP.md |
ci | Build, Actions, releases | .github/workflows/, scripts/ |
How to Use Subagents
When spawning a Task for exploration or implementation:
- Identify the domain from the file patterns in
.opencode/agents.toml - Include the subagent context in your Task prompt
- Scope file searches to the relevant patterns
Example: For web viewer work, spawn an Explore agent with:
"Focus on web/src/. This is the web agent domain - React components, D3/Dagre graphs. See .opencode/agents.toml for full context."Why Subagents Matter
- Reduced context overhead: Focus on relevant files only
- Domain expertise: Each agent has specialized instructions
- Parallel work: Multiple agents can work on different domains simultaneously
- Consistency: Same patterns applied across similar work
Architecture
src/
├── main.rs # CLI entry, command dispatch
├── lib.rs # Public API exports
├── db.rs # SQLite database via Diesel ORM
├── schema.rs # Diesel table definitions
├── init.rs # Project initialization (deciduous init)
├── serve.rs # HTTP server for web UI
└── export.rs # DOT export and PR writeup generation
web/ # React/TypeScript web viewer source
├── src/
│ ├── utils/
│ │ └── graphProcessing.ts # Chain building, session grouping algorithms
│ ├── types/
│ │ └── graph.ts # TypeScript types for graph data
│ └── components/ # React components
└── dist/ # Built output (singlefile HTML)
.deciduous/
├── deciduous.db # SQLite database (decision graph)
├── documents/ # Content-hash named document attachments
├── config.toml # Branch/feature configuration
├── sync/ # Shared graph records, one JSON file each (tracked in git)
└── narratives.md # Narrative trackingWeb Viewer Development
When modifying web viewer code (TypeScript/React), you MUST rebuild and update the embedded HTML.
Key Files
| File | Purpose |
web/src/utils/graphProcessing.ts | Chain building, BFS traversal, session grouping |
web/src/types/graph.ts | TypeScript interfaces for nodes, edges, chains |
src/viewer.html | Embedded viewer served by deciduous serve |
docs/demo/index.html | Static demo viewer for GitHub Pages |
Rebuild Process
After modifying any web/src/** files:
# 1. Build the web viewer (outputs singlefile HTML)
cd web && npm run build && cd ..
# 2. Copy to embedded locations (use absolute paths)
cp /path/to/deciduous/web/dist/index.html /path/to/deciduous/src/viewer.html
cp /path/to/deciduous/web/dist/index.html /path/to/deciduous/docs/demo/index.html
# 3. Run Rust tests to ensure nothing broke
cargo test
# 4. Build release binary
cargo build --releaseChain/Graph Processing Notes
The buildChains function in graphProcessing.ts uses BFS to traverse full connected components:
- Follows both outgoing AND incoming edges
- No artificial node limits (MAX_CHAIN_NODES = 0 means unlimited)
- Chains include all nodes reachable from any direction
This ensures viewing a single chain shows the entire decision tree, not a truncated subset.
CLI Commands
| Command | Description |
deciduous init | Initialize deciduous in current directory |
deciduous update | Update Claude integration files to latest version |
deciduous check-update | Check if integration files need updating |
deciduous add <type> "title" | Add a node (goal/decision/option/action/outcome/observation/revisit) |
deciduous link <from> <to> | Create edge between nodes |
deciduous status <id> <status> | Update node status |
deciduous nodes | List all nodes |
deciduous edges | List all edges |
deciduous graph | Output full graph as JSON |
deciduous commands | Show recent command log |
deciduous backup | Create database backup |
deciduous serve | Start web viewer |
deciduous sync | Reconcile .deciduous/graph.json with the local DB, then export docs/graph-data.json |
deciduous dot | Export graph as DOT format |
deciduous writeup | Generate PR writeup markdown |
deciduous sync --check | Report pending sync changes, exit 1 if any |
deciduous migrate | Add change_id columns for sync |
deciduous doc attach <node_id> <file> | Attach file to a decision node |
deciduous doc list [node_id] | List attached documents (all or per-node) |
deciduous doc show <id> | Show document details |
deciduous doc describe <id> [text] | Set/update document description (--ai for AI) |
deciduous doc open <id> | Open document in default application |
deciduous doc detach <id> | Soft-delete a document attachment |
deciduous doc gc | Garbage collect orphaned document files |
DOT Export Options
deciduous dot [OPTIONS]
Options:
-o, --output <FILE> Output file (default: stdout)
-r, --roots <IDS> Root node IDs for BFS traversal (comma-separated)
-n, --nodes <SPEC> Specific node IDs or ranges (e.g., "1-11" or "1,3,5-10")
-t, --title <TITLE> Graph title
--rankdir <DIR> Graph direction: TB (top-bottom) or LR (left-right)
--png Generate PNG file (requires graphviz installed)Writeup Options
deciduous writeup [OPTIONS]
Options:
-t, --title <TITLE> PR title
-r, --roots <IDS> Root node IDs (comma-separated, traverses children)
-n, --nodes <SPEC> Specific node IDs or ranges
-o, --output <FILE> Output file (default: stdout)
--png <FILENAME> PNG file to embed (auto-detects GitHub repo/branch for URL)
--no-dot Skip DOT graph section
--no-test-plan Skip test plan sectionRecommended workflow with --auto:
# 1. Generate branch-specific PNG (avoids merge conflicts!)
deciduous dot --auto --nodes 1-11
# 2. Commit and push
git add docs/decision-graph-*.dot docs/decision-graph-*.png
git commit -m "docs: add decision graph"
git push
# 3. Generate writeup with auto PNG detection
deciduous writeup --auto -t "My PR" --nodes 1-11
# 4. Update PR body
gh pr edit N --body "$(deciduous writeup --auto -t 'My PR' --nodes 1-11)"The --auto flag generates branch-specific filenames (e.g., docs/decision-graph-feature-foo.png) which prevents merge conflicts when multiple PRs each have their own graph.
Database Rules
CRITICAL: NEVER delete the SQLite database (.deciduous/deciduous.db)
The database contains the decision graph. If you need to clear data:
deciduous backupfirst- Ask the user before any destructive operation
Multi-User Sync
Each machine keeps a private .deciduous/deciduous.db (gitignored). The shared truth is .deciduous/graph.json: one file holding every node, edge, theme, and tag, committed with the code. The database layer writes it on every mutation, so CLI, MCP, and HTTP API all publish. deciduous sync reconciles both ways (newer updated_at wins; deletes are tombstones; edges import once both endpoints exist).
git pull
deciduous sync # import theirs, export yours, refresh docs/graph-data.json
git add .deciduous/graph.json docs/graph-data.json
git commit -m "graph: ..." && git push- Node references anywhere: local id or change_id prefix (
deciduous link a1b2c3d4 58). - Two people editing the graph: git merges the file record by record via the
deciduousmerge driver (.gitattributes+merge.deciduous.driver, registered by init/update/sync) — both sides' additions survive, and a record both changed merges field by field. Leftover<<<<<<<markers are merged bydeciduous sync. docs/graph-data.jsonconflicts: take either side, rerundeciduous sync.deciduous events …is a deprecated alias;.deciduous/patches/is dead. A 0.17.deciduous/sync/directory is folded intograph.jsonon the nextsync,init, orupdate.
Full design: docs/MULTI_USER_SYNC.md.
Development Rules
Code Quality - MANDATORY
- ALWAYS run tests before committing:
Do NOT commit if tests fail.cargo test - ALWAYS ensure code compiles:
Do NOT commit code that doesn't compile.cargo build --release - Write tests for new functionality:
- New commands need tests
- Bug fixes need regression tests
- Edge cases need coverage
- Run clippy for lints:
cargo clippy
Git Staging Rules - CRITICAL
NEVER use broad git add commands that stage everything:
- ❌
git add -A- stages ALL changes including untracked files - ❌
git add .- stages everything in current directory - ❌
git add -aorgit commit -am- auto-stages all tracked changes - ❌
git add *- glob patterns can catch unintended files
ALWAYS stage files explicitly by name:
- ✅
git add src/main.rs src/lib.rs - ✅
git add Cargo.toml Cargo.lock - ✅
git add .opencode/commands/decision.md
Why this matters:
- Prevents accidentally committing sensitive files (.env, credentials)
- Prevents committing large binaries or build artifacts
- Forces you to review exactly what you're committing
- Catches unintended changes before they enter git history
Pre-Commit Checklist
cargo test # All tests pass?
cargo build --release # Compiles cleanly?
cargo clippy # No warnings?Only commit if ALL pass.
Release Process - MANDATORY
Semantic Versioning (SemVer)
Follow semver strictly: MAJOR.MINOR.PATCH
| Change Type | Version Bump | Example |
| Breaking API change | MAJOR | 1.0.0 → 2.0.0 |
| New feature (backward compatible) | MINOR | 1.0.0 → 1.1.0 |
| Bug fix (backward compatible) | PATCH | 1.0.0 → 1.0.1 |
Release Checklist
- Update version in Cargo.toml:
version = "X.Y.Z" - Update embedded changelog in
src/changelog.rs:
This is REQUIRED - users see these notes when upgrading!// Add new release at TOP of RELEASES array (newest first) Release { version: "X.Y.Z", highlights: &[ "Brief description of feature 1", "Brief description of feature 2", ], }, - Run full test suite:
cargo test cargo build --release - Commit the version bump:
git add Cargo.toml Cargo.lock src/changelog.rs git commit -m "release: vX.Y.Z - <brief description>" - Create and push a git tag:
git tag -a vX.Y.Z -m "vX.Y.Z: <release notes>" git push --no-verify origin main git push origin vX.Y.Z - Publish to crates.io:
cargo publish --allow-dirty - Create GitHub Release:
gh release create vX.Y.Z --title "vX.Y.Z" --notes "<release notes>" - Update local version file:
deciduous update
Release Notes Format
## vX.Y.Z
### Added
- New feature A
- New feature B
### Changed
- Updated behavior of X
### Fixed
- Bug fix for Y
- Bug fix for Z
### Breaking Changes (if MAJOR bump)
- API change descriptionExample Full Release
# 1. Bump version
sed -i '' 's/version = "0.3.4"/version = "0.3.5"/' Cargo.toml
# 2. Test
cargo test && cargo build --release
# 3. Commit
git add Cargo.toml Cargo.lock
git commit -m "release: v0.3.5 - fix detail panel layout"
# 4. Tag
git tag -a v0.3.5 -m "v0.3.5: Fix detail panel layout for connections
- Rationale text now displays on separate line
- Full node titles shown without truncation
- Improved readability of incoming/outgoing connections"
# 5. Push
git push origin main
git push origin v0.3.5
# 6. Publish
cargo publish
# 7. GitHub Release
gh release create v0.3.5 --title "v0.3.5" --notes "Fix detail panel layout for connections
- Rationale text now displays on separate line
- Full node titles shown without truncation
- Improved readability of incoming/outgoing connections"External Dependencies
Required at Runtime
| Dependency | Required For | Install |
| None | Core functionality | - |
The deciduous binary is self-contained for core features.
Optional Dependencies
| Dependency | Required For | Install |
| graphviz | --png flag (DOT → PNG) | brew install graphviz / apt install graphviz |
If graphviz is not installed, deciduous dot --png will fail with a helpful error message.
GitHub Action for PNG Cleanup
When you run deciduous init, a GitHub workflow is created at .github/workflows/cleanup-decision-graphs.yml. This workflow:
- Triggers after any PR is merged
- Finds decision graph PNG/DOT files
- Creates a cleanup branch and removes them
- Auto-merges the cleanup PR
This keeps your repo clean of accumulated visualization files while still having nice graphs in PRs.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

