Skip to main content

VentilatePro documentation

Notes workflow

Create notes from the terminal, read normalized note feeds across multiple models, search by tags and text, and sync locally queued work later.

VentilatePro CLI v0.7.0

Create

ventilatepro notes create --project 123 --body "Captured from terminal"

Filter and search

ventilatepro notes list --project 123 --type general-info --source cli --tags field,urgent --query terminal

Sync queued notes

ventilatepro notes sync --project 123

Create notes

The CLI write path creates `GeneralInfo` notes on the server. 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.
  • --captured-at preserves the original capture timestamp.

Read notes

`notes list` and `notes show` read a normalized view across `GeneralInfo`, `DesignMinute`, and `Decision`.

ventilatepro notes list --project 123 ventilatepro notes show general-info:42 --project 123 ventilatepro notes list --project 123 --json
Field Meaning
note_refTyped identifier such as general-info:42.
typeNormalized note type returned by the CLI API.
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.

Filter and search

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

Option Behavior
--typeFilter to `general-info`, `design-minute`, or `decision`.
--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 --type general-info --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.