Skip to content
← Public packages

@kentcdodds/workflowy

Thin secret-backed helpers for the WorkFlowy REST API: targets, nodes, mirrors, and outline export.

README.md

27 lines · 1.2 KB · Markdown

@kentcdodds/workflowy

Intent

Give agents thin, secret-backed helpers for the WorkFlowy REST API: list targets/shortcuts, create and edit outline nodes, move/complete them, create mirrors, and export the outline when needed — without wrapping WorkFlowy into a heavier planning system.

Setup

  1. Mint a WorkFlowy API key on the API key page.
  2. Save it as the user-scoped secret WORKFLOWY_API_KEY with host workflowy.com: configure WORKFLOWY_API_KEY.
  3. API reference: docs / markdown.
  4. See AGENTS.md for imports, helpers, and smoke tests.

Done when

  • smokeTest lists targets successfully and returns a short summary.
  • Agents can list/create/update/move/complete nodes under parents such as inbox, today, or a node id.
  • Mirror create/delete and full-outline export are available when needed (exportNodes is rate-limited to 1 request/minute).