Integrations and import

The Notez CLI

Updated 80 views

The Notez CLI is a small native binary for capturing notes without leaving your terminal.

Install

macOS and Linux

Bash
curl -fsSL https://notez.dev/install.sh | sh

Windows — use the PowerShell installer linked from the downloads page.

Binaries are published for macOS (arm64, x64), Linux (arm64, x64), and Windows (x64), each with a .sha256 checksum.

Log in

Bash
notez login

This opens Notez to authorize the terminal to capture notes into your workspace. Run it once per machine. notez logout forgets the stored key.

The key goes straight from the browser to your terminal and is never shown on screen. Notez keeps only a hash of it, so it cannot be read back from your account either — if a machine loses it, just run notez login again.

Capture a note

Bash
notez "postgres pool exhausted under load — check pgbouncer config"

The note is in your workspace immediately.

You can also pipe input in:

Bash
git log --oneline -10 | notez --title "Release commits"

Upload a file

Pass a path instead of text and the CLI detects it automatically:

Bash
notez ./architecture-diagram.png

Commands and flags

Command

What it does

notez "text"

Capture text as a note

notez ./file

Upload a file

notez login

Authorize this terminal

notez logout

Forget the stored CLI key

notez update

Check for and install the latest version

Flag

What it does

--title <TITLE>

Set an explicit title

--json

Print the created note as JSON

Without --title, the title is taken from the first line of your text, trimmed if it is long. For multi-line captures that means the title is the first line only — pass --title when you want something better.

Bare URLs become bookmarks

If the text you capture is just a URL starting with http:// or https://, it is saved as a bookmark note with an empty body rather than a text note. See Quick capture and bookmarks.

Capture-only, by design

The CLI has no list, search, edit, or delete. Its one job is to never make you wait when you have a thought.

For reading and searching from a terminal-adjacent tool, use the MCP server with Claude Code or Cursor. For notes created by a script or a scheduled job with no one at a terminal, a webhook needs nothing installed — one curl is enough.

Useful patterns

Capture with an explicit title

Bash
notez "check whether the retry backoff is actually exponential" --title "TODO: retry backoff"

Script it — --json prints the created note, so you can pipe it into jq and chain further steps.

Keeping it updated

Bash
notez update

The CLI updates itself. (The macOS desktop app does not — it shows a banner and you download manually.)

Which workspace do notes land in?

The workspace the CLI key is bound to. To capture into a different one, switch workspaces in the app and run notez login again.

The key can do only what the CLI does — capture notes and upload files — and only in that workspace. It cannot read, change or delete notes, and it cannot reach your other workspaces, so a key left on a shared machine exposes nothing beyond the ability to add notes.

Source badges

CLI notes carry a CLI badge in the app, so you can spot everything captured from a terminal.

Troubleshooting

command not found: notez — the install directory is not on your PATH. Open a new terminal, or add it.

Authentication errors — run notez logout then notez login again. The key may have been revoked from Settings → Integrations, or created before v0.15.0, when every existing CLI key stopped working. Since version 0.1.3 the CLI says which it is (invalid, expired, or not allowed) instead of printing a raw server error; run notez update to get it.

A file will not upload — check it is under your plan's max file size (25 MB Free, 250 MB Pro, 500 MB Ultra) and that you have storage left.

Was this article helpful?