Skip to main content
CurfluffleGRUNTS
Skip to content
Curfluffle

Use Cases

Tutorial: Document & explain

Plan clear docs for a system, API, onboarding, or architecture.

  1. 1Name the target and audience.
  2. 2Get the doc type, an outline, what to extract from the code, examples, and upkeep.

API — deterministic output.

curl -X POST $CURFLUFFLE_API_URL/tools/document.plan \
  -H "Authorization: Bearer $CURFLUFFLE_API_KEY" -H "Content-Type: application/json" \
  -d '{"target":"CameraShake system","audience":"team"}'
# → { ok:true, data:{ result:{ type, outline, extraction, examples, upkeep }, markdown } }