notion-cli

Notion CLI

Look things up before answering

The CLI is self-documenting. Always prefer running these commands over guessing syntax or relying on memorized knowledge:

• ntn api ls — list every public API endpoint.
• ntn api <path> --help — show methods, doc links, and usage for an endpoint.
• ntn api <path> --docs — print the full official docs for an endpoint.
• ntn api <path> --spec — print a reduced OpenAPI fragment (useful for understanding request/response schemas).
• ntn pages get <page-id> — retrieve a page as Markdown. Use this to read page content.
• ntn <command> --help — help for any command or subcommand.

Install

curl -fsSL https://ntn.dev | bash

Authentication

• The CLI automatically uses NOTION_API_TOKEN when it is set.
• Check NOTION_API_TOKEN first. If it is already set, prefer using it instead of telling the user to run ntn login.
• ntn login / ntn logout — log the CLI in or out (only use if not using NOTION_API_TOKEN). ntn login requires the user to visit a URL in a web browser.

ntn api

Run ntn api --help for full syntax. Quick summary:

# GET with query param
ntn api v1/users page_size==100
 
# POST with inline body fields

The method is inferred (GET by default, POST when a body is present). Override with -X METHOD.

Markdown for pages and comments

Prefer ntn pages create / ntn pages update for Markdown page content. Use the markdown field when creating or updating comments via ntn api.

The markdown field supports inline formatting (bold, italic, code, links, etc.). Only fall back to rich_text if you need features that Markdown cannot express (e.g. mentions, custom emoji, or colors).

ntn files

Convenience wrapper around the File Uploads API.

ntn workers

Manage Notion workers (deploy, list, execute, etc.). Run ntn workers --help for subcommands.