Notion CLI

Install the Notion CLI and learn the core commands for authentication, Notion Workers, and API requests.

ntn is the Notion CLI. Use it to authenticate with Notion, deploy and manage Notion Workers, and make API requests — all from your terminal.

Install

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

Verify the installation:

ntn --version

See Installation for more installation options.

Authenticate

Log in to connect the CLI to your Notion workspace:

ntn login

This opens a browser window where you authorize access. Your credentials are stored securely in your system’s keychain. See Authentication for more details.

What you can do

Workers

Deploy, manage, and debug Notion Workers.

API requests

Make Notion API requests directly from the terminal.

Data sources

Create, query, and manage data sources from the terminal.

File uploads

Upload static assets like images and PDFs to Notion.

Manage Notion Workers

Create, deploy, and operate Workers — small TypeScript programs that extend Notion with syncs, tools, and webhooks:

ntn workers new          # Scaffold a project
ntn workers deploy       # Build and upload
ntn workers list         # List deployed workers

See the Workers guide to get started.

Make API requests

Make authenticated requests to the Notion API with inline JSON construction and shell completion:

ntn api v1/users                             # GET users
ntn api v1/pages parent[page_id]=abc123      # POST with inline body fields
ntn api v1/pages/abc123 -X PATCH archived:=true  # PATCH with typed assignment

See the API requests guide for the full inline syntax reference.

Upload files

Upload static assets like images and PDFs to reference from Notion pages:

ntn files create < photo.png
ntn files create --external-url https://example.com/photo.png
ntn files list

See the file uploads guide for details.

Next steps

Installation

Alternative install methods and shell completions.

Authentication

Manage login sessions and credentials.

Command reference

Full reference for every ntn command.

Notion Workers quickstart

Create and deploy your first Notion Worker.