Skip to content
VentilatePro Docs
Open app
Browse documentation

DocumentationIntegrations

Notes workflow

Capture HVAC field notes from the terminal, search project records, and synchronize queued notes with idempotent retries using VentilatePro CLI.

View Markdown CLI v0.8.4

Create notes#

A note has a kind: note for reference material and quick captures, meeting, call, site_visit, or agent_session. Titles may be provided explicitly or derived from the first non-empty body line.

ventilatepro notes create --project 123 --body "Captured from terminal"
cat site-walk.md | ventilatepro notes create --project 123 --stdin --tags field,urgent
  • --project is required because notes are project-scoped.
  • --title is optional.
  • --body and --stdin are mutually exclusive.
  • --tags stores tags on the note and also powers filtering.
  • --kind sets the kind; --pinned marks a key reference agents always load.
  • --occurred-at records when it happened (--captured-at still works).

Read notes#

notes list and notes show read notes and decisions together, pinned notes first. notes update can re-kind, pin, or archive a note.

ventilatepro notes list --project 123
ventilatepro notes show note:42 --project 123
ventilatepro notes list --project 123 --json
Field Meaning
note_refnote:42 or decision:7. Older general-info: and design-minute: references still resolve.
typenote or decision; notes also carry kind, pinned, and archived.
sourceOrigin of the note, currently `cli` or `web`.
tagsTag list used for filtering and search.
metadataExtra fields for note types like meeting minutes and decisions.

Use structured filters to narrow the note feed without building a second local index.

Option Behavior
--typeFilter to note or decision; --kind, --pinned, and --include-archived narrow further.
--sourceFilter by `cli` or `web` origin.
--tagsComma-separated tags; all listed tags must be present.
--querySearches note ref, title, body, tags, and metadata strings.
ventilatepro notes list --project 123 --kind meeting --source cli --tags field,urgent --query terminal

Offline queue and sync#

`notes create` safely queues the note locally on network failures and server 5xx responses. Later, `notes sync` retries the queued payload using the same idempotency key.

ventilatepro notes sync
ventilatepro notes sync --project 123
  • Network errors and 5xx responses are queueable.
  • 4xx validation errors and auth errors are not queued.
  • A successfully queued note still returns exit code 0 so capture workflows do not fail unnecessarily.
  • `notes sync` returns non-zero when queued items still fail after retry.

Search documentation

Search guides, examples, and reference material.

↑ ↓ to choose · Enter to open · Esc to close