Configuration and data

Last updated

Configuration

The CLI keeps a small set of preferences you can read and change with notate config:

notate config set <key> <value>
notate config get <key>
notate config list
notate config reset

Keys:

  • server — the API the CLI talks to. Defaults to the hosted Notate API.
  • workspace — the active workspace (set it with notate workspaces use).
  • defaultMode, defaultSort, pageSize — display preferences for listing output.

For example, point the CLI at a self-hosted or local server:

notate config set server http://localhost:3004

Where things are stored

  • Config (server URL, active workspace, display preferences) lives in a JSON file in your operating system’s config directory. See it with notate config list.
  • Credentials (your access and refresh tokens, and on encrypted accounts the content key) are stored in your OS keychain, not on disk in plaintext. notate logout clears them for the current server.

Encrypted accounts

If your account has end-to-end encryption turned on, the CLI encrypts note fields (title, content, summary, transcript, and tags) on your machine before they are sent, and decrypts them when you read. The key is unlocked at login and cached in your keychain.

Because the server never sees your plaintext, some features that rely on server-side processing are unavailable on encrypted accounts:

  • notes search
  • tags list, tags rename, tags delete
  • ask, summarize, gentags, rewrite, transcribe
  • server-side tag aggregation in stats

The CLI checks your encryption state on each run, so it will never write plaintext to an encrypted account.

Getting help

Every command supports --help:

notate --help
notate notes --help
notate notes create --help