Notion CLI

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

macOS and Linux
Windows
npm

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

If the installer says it couldn’t install the Notion CLI to /usr/local/bin, pick a directory you can write to with NTN_INSTALL_DIR:

curl -fsSL https://ntn.dev | NTN_INSTALL_DIR="$HOME/.local/bin" bash

If that directory isn’t on your PATH, the installer prints the line to add to your shell startup file.To inspect the installer before you run it, view the install script.

The install script doesn’t support Windows. In PowerShell or Command Prompt, install with WinGet:

winget install Notion.ntn

The WinGet package supports only Windows x64 (x86-64/AMD64). To confirm the package installed, run winget list --exact --id Notion.ntn.

Use npm on macOS, Linux, or Windows. This requires Node.js 22+ and npm 10+.

npm install --global ntn

After you install, restart your terminal so ntn is on your PATH. Verify the installation:

ntn --version

See Installation for update steps and shell completions.

Authenticate

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.

Get started

Guides

Reference

Install

Authenticate

What you can do

Workers

API requests

Data sources

File uploads

Manage Notion Workers

Make API requests

Upload files

Next steps

Installation

Authentication

Command reference

Notion Workers quickstart

​Install

​Authenticate

​What you can do

Workers

API requests

Data sources

File uploads

​Manage Notion Workers

​Make API requests

​Upload files

​Next steps

Installation

Authentication

Command reference

Notion Workers quickstart

Install

Authenticate

What you can do

Manage Notion Workers

Make API requests

Upload files

Next steps