API Clients

ntn

ntn is the official Notion command-line interface, letting developers and coding agents query the Notion API, deploy Workers, and upload files without leaving the terminal.

Visit official website ↗
✓ Software download·Open Source·Updated October 16, 2026
DeveloperNotion Labs, Inc.
LicenseOpen Source
File size5.6 MB
Languageen-US
Downloads10

ntn: The Notion CLI for Workers, API Calls, and File Uploads

ntn is the Notion CLI, a terminal tool for people who would rather script their work than click through it. It signs in to a Notion workspace through the browser, stores the resulting credentials in the system keychain, and then exposes the platform in three directions: raw API requests, data sources, and Workers. Workers are small TypeScript programs that extend a workspace with syncs, tools, and webhooks, and ntn handles scaffolding, deploying, and listing them. File uploads are covered too, so an image or PDF can be attached to a page from a shell command. Shell completions make the command set discoverable without constant reference to documentation.

The tool exists because Notion stopped being only a place for documents. Workspaces now hold databases, data sources, and custom code, and the people who maintain that side of things often prefer a shell to a settings panel. With ntn, a call to the API looks like any other command: a path, a method, and fields written inline, including typed values for booleans and numbers. That makes it practical to check a response, script a small repair, or wire a workspace action into a build step. Where the content comes from barely matters; whether a recap started life in Cisco Webex Meetings or in a team retrospective, getting structured data in and out quickly is the whole point.

Benefits of Using ntn

The main benefit of ntn is speed of access. Anything the Notion API can do is reachable from the terminal, so a developer can inspect a workspace, create a page, or patch a property without switching to a browser or writing a script around a client library. The second benefit is automation that stays inspectable. Workers built with ntn can carry syncs, tools, and webhooks, and because the deploy step runs where the code lives, a change can be tested, uploaded, and checked from the same window. Uploading files is the third practical gain: an image or a PDF becomes a page asset with one command rather than a manual drag through the interface. There is also a lower cost of entry than a full API integration. Credentials live in the system keychain after a single login, completions guide the syntax, and the same commands behave on every desktop platform the tool supports, which shortens the gap between an idea and a working automation.

ntn features

Key capabilities and highlights.

Feature 1

Workspace Sign-In From the Terminal

Running ntn login opens a browser window where access is authorised, and the resulting credentials are kept in the operating system keychain, so there is no token pasted into a config file or shell history. Signing out and back in is the first fix to try when the wrong account answers.

Feature 2

Direct API Requests

An API call is expressed as a path with an optional method and inline fields, so ntn api v1/users reads like any other command and typed assignments handle booleans and numbers without hand-written JSON. That keeps small checks and repairs inside the shell.

Feature 3

Worker Scaffolding and Deployment

Workers can be created, built, and uploaded with three commands: one scaffolds a project, one deploys it, and one lists what is live. They add syncs, tools, and webhooks to a workspace, and the logs can then be read from Notion itself.

Feature 4

Data Source Management

Data sources can be created, queried, and managed from the command line, which makes it possible to seed a database, inspect its shape, or correct entries in a scripted pass instead of clicking through rows one by one. It is the part of the workflow that benefits most from a repeatable command.

Feature 5

File Uploads as Page Assets

Images and PDFs can be pushed to Notion from a local path or a public URL, and uploaded assets can be listed afterwards, so attaching a file to a page stops being a manual step in a build or publishing process.

Feature 6

Shell Completions

Tab completion is available for bash, fish, zsh, PowerShell, and elvish, so command and flag names can be discovered by pressing a key rather than returning to the reference pages whenever an unfamiliar option is needed. It shortens the learning curve for a large command set.

Feature 7

Consistent Across Desktop Platforms

The commands behave the same on Mac, Linux, and Windows, which means a script written on one machine can be handed to a colleague on another without rewrites, and Workers appear identically wherever they are inspected from a terminal.

Feature 8

Built for Agents as Well as People

Output from ntn is structured enough for AI coding agents to drive the same commands a developer would type, which is why the CLI is documented for agent workflows as well as interactive use. Updating is a single command, so scripted setups do not drift.

Old versions

Browse historical releases and previous builds.

0.23.19October 6, 2026
0.23.17October 3, 2026
0.23.15October 1, 2026
0.23.132026-09-29
0.23.122026-09-29
0.23.112026-09-28
0.23.102026-09-24
0.23.92026-09-22
0.23.82026-09-19

Frequently asked questions

Common questions about ntn.

What is ntn?

It is the official command-line interface for Notion. It signs in to a workspace and exposes the API, data sources, file uploads, and Worker deployment from a shell, aimed at developers and technical builders.

Do I need it to use Notion?

No. The CLI is optional and meant for developer workflows, so everything most people do in Notion continues to work through the normal apps without ever opening a terminal.

Does it work on mobile?

No. It runs in a terminal on a desktop computer, which is why the mobile apps remain the way to read and edit content when you are away from a keyboard.

Is it free to use?

The CLI itself is available on all plans, but deploying and managing Workers requires a higher-tier plan, and some developer features may need an administrator to enable them first.

Why does an API command fail when the syntax looks right?

Usually it is access. If you cannot open the page or database in Notion itself, the CLI cannot read or change it either, so permissions are worth checking before the command syntax.

How do I update it?

Run ntn update, or use whichever package manager installed it. Outdated versions can behave differently, so updating is the first troubleshooting step when something unexpected happens.

Can Workers be managed in Notion instead?

Partly. With Developer Mode turned on you can view Workers, read their logs, switch them off, or delete them in Notion. Deploying them, or changing their code and setup, is a job for the CLI.

What is a Worker, exactly?

A Worker is a small TypeScript program that extends a Notion workspace with syncs, tools, and webhooks. The CLI scaffolds, builds, and uploads them, so the whole lifecycle stays in one place.

Comments

Leave a Reply

Your email address will not be published. Required fields are marked *

Software download

Download ntn

ntn is the official Notion command-line interface, letting developers and coding agents query the Notion API, deploy Workers, and upload files without leaving the terminal.