Skip to content

Catafal/notion-cli

BranchesTags

Repository files navigation

███╗   ██╗ ██████╗ ████████╗██╗ ██████╗ ███╗   ██╗     ██████╗██╗     ██╗
████╗  ██║██╔═══██╗╚══██╔══╝██║██╔═══██╗████╗  ██║    ██╔════╝██║     ██║
██╔██╗ ██║██║   ██║   ██║   ██║██║   ██║██╔██╗ ██║    ██║     ██║     ██║
██║╚██╗██║██║   ██║   ██║   ██║██║   ██║██║╚██╗██║    ██║     ██║     ██║
██║ ╚████║╚██████╔╝   ██║   ██║╚██████╔╝██║ ╚████║    ╚██████╗███████╗██║
╚═╝  ╚═══╝ ╚═════╝    ╚═╝   ╚═╝ ╚═════╝ ╚═╝  ╚═══╝     ╚═════╝╚══════╝╚═╝

CI/CD Pipeline npm version Node.js Version License

IMPORTANT NOTICE:

This is an independent, unofficial command-line tool for working with Notion's API. This project is not affiliated with, endorsed by, or sponsored by Notion Labs, Inc. "Notion" is a registered trademark of Notion Labs, Inc.

Notion CLI for AI Agents & Automation

A powerful command-line interface for Notion's API, optimized for AI coding assistants and automation scripts.

Key Features:

  • 🚀 Fast & Direct: Native API integration with intelligent caching
  • 🤖 AI-First Design: JSON output, structured errors, exit codes
  • ⚡ Non-Interactive: Perfect for scripts and automation
  • 📊 Flexible Output: JSON, CSV, markdown tables, or raw API responses
  • 🔍 Schema Discovery: AI-friendly database schema extraction
  • 🗄️ Workspace Caching: Fast database lookups without API calls
  • 🧠 Smart ID Resolution: Automatic database_id → data_source_id conversion
  • 🔎 Fuzzy Search: Typo-tolerant name resolution and database filtering
  • 🔄 Reliable: Automatic retry with exponential backoff and circuit breaker
  • 🔒 Secure: 0 production vulnerabilities

See CHANGELOG.md for version history and release notes.

Quick Start

Installation

# From npm (recommended)
npm install -g @catafal/notion-cli

# Or from source
npm install -g Catafal/notion-cli

Note: Windows users installing from source should use the local clone method due to symlink limitations:

git clone https://github.com/Catafal/notion-cli
cd notion-cli
npm install
npm run build
npm link

First-Time Setup

# Run the interactive setup wizard
notion-cli init

This guides you through:

  1. Setting your Notion API token
  2. Testing the connection
  3. Syncing your workspace

Manual setup (if you prefer):

# Both token formats are supported:
export NOTION_TOKEN="secret_your_token_here"   # Internal integration token
export NOTION_TOKEN="ntn_your_token_here"      # OAuth token (newer format)

notion-cli whoami       # Test connection
notion-cli sync         # Cache workspace

Get your API token: https://developers.notion.com/docs/create-a-notion-integration

Common Commands

# List your databases
notion-cli list --json

# Discover database schema
notion-cli db schema <DATA_SOURCE_ID> --with-examples --json

# Create a page (simple properties mode)
notion-cli page create -d <DATA_SOURCE_ID> -S --properties '{
  "Name": "My Task",
  "Status": "In Progress",
  "Priority": 5,
  "Due Date": "tomorrow"
}'

# Search workspace
notion-cli search "project" --json

All commands support --json for machine-readable output.

Key Features for AI Agents

Simple Properties — 70% Less Complexity

Use flat JSON instead of complex nested Notion API structures with the -S flag:

# Simple properties with -S flag
notion-cli page create -d DB_ID -S --properties '{
  "Name": "Task",
  "Status": "In Progress",
  "Priority": 5,
  "Tags": ["urgent", "bug"],
  "Due Date": "tomorrow"
}'

# Update is just as easy
notion-cli page update PAGE_ID -S --properties '{
  "Status": "Done",
  "Completed": true
}'

Supports 13 property types, case-insensitive matching, and relative dates ("today", "+7 days", "+2 weeks").

📖 Simple Properties Guide

Smart Database ID Resolution

No need to worry about database_id vs data_source_id — the CLI auto-converts:

# Both work! Use whichever ID you have
notion-cli db retrieve 1fb79d4c71bb8032b722c82305b63a00  # database_id
notion-cli db retrieve 2gc80e5d82cc9043c833d93416c74b11  # data_source_id

📖 Smart ID Resolution

JSON Mode — Perfect for AI Processing

Every command supports --json for structured, parseable output:

notion-cli db query <ID> --json | jq '.data.results[].properties'

Error responses are also structured JSON with exit codes (0 = success, 1 = API error, 2 = CLI error).

Schema Discovery

Extract complete database schemas in AI-friendly formats:

notion-cli db schema <DATA_SOURCE_ID> --with-examples --json

Workspace Caching

Cache your workspace locally for instant lookups:

notion-cli sync                          # One-time sync
notion-cli db query "Tasks Database" --json  # Use names instead of IDs
notion-cli list --filter "tasks"         # Fuzzy-filter cached databases
notion-cli cache:info --json             # Check cache freshness

Output Size Control

Reduce response size for large queries:

notion-cli db query <ID> --minimal --compact-json --page-size 10
notion-cli db query <ID> --select "Name,Status" --minimal
NO_COLOR=1 notion-cli search "My Page"   # Strip ANSI codes for clean parsing

📖 AI Agent Guide | 📖 AI Agent Cookbook

Core Commands

Setup & Diagnostics

notion-cli init           # First-time setup wizard
notion-cli doctor         # Health check and diagnostics (aliases: diagnose, healthcheck)
notion-cli whoami         # Test connectivity (aliases: test, health)

Database Commands

notion-cli db retrieve <ID>                          # Get database metadata
notion-cli db query <ID> --json                      # Query with results
notion-cli db query <ID> --filter '{"property": "Status", "select": {"equals": "Done"}}' --json
notion-cli db schema <ID> --with-examples --json     # Extract schema
notion-cli db update <ID> --title "New Title"        # Update database
notion-cli db create --parent-page <PAGE_ID> --title "My DB" --properties '{...}'

📖 Filter Guide

Page Commands

notion-cli page create -d <DB_ID> -S --properties '{...}'   # Create in database
notion-cli page create -p <PAGE_ID> -f notes.md              # Create from markdown
notion-cli page retrieve <PAGE_ID> --json                    # Get page
notion-cli page update <PAGE_ID> -S --properties '{...}'     # Update properties
notion-cli page export <PAGE_ID> -o page.md                  # Export to markdown
notion-cli page export <PAGE_ID> --json -o page.json         # Export to JSON

📖 Export Guide

Block Commands

notion-cli block retrieve <BLOCK_ID>                  # Get block
notion-cli block append <BLOCK_ID> --children '[...]' # Append children
notion-cli block update <BLOCK_ID> --content "text"   # Update block
notion-cli block delete <BLOCK_ID>                    # Delete block

Batch Operations

notion-cli batch retrieve <ID1> <ID2> <ID3> --json   # Retrieve multiple
notion-cli batch delete <ID1> <ID2> <ID3>             # Delete multiple in parallel

📖 Batch Operations Guide

Daily Journal

notion-cli daily                                       # Create/find today's entry
notion-cli daily "Had a productive standup"            # Create with body content
notion-cli daily "Another thought"                     # Append to existing entry
notion-cli daily setup DB_ID                           # Setup: point to existing database
notion-cli daily setup --auto PAGE_ID                  # Setup: auto-create database

📖 Daily Journal Guide

Templates

notion-cli template save "meeting" -p '{"Status": "To Do"}' -c "# Agenda" --icon "📋"
notion-cli template list                                       # List all templates
notion-cli template get "meeting"                              # View template details
notion-cli template use "meeting" --to tasks --title "Sprint"  # Create page from template
notion-cli template remove "meeting"                           # Delete a template
notion-cli quick "My Meeting" --template meeting --to tasks    # Quick capture with template

📖 Templates Guide

Append

notion-cli append "Daily Log" "Had a productive standup"       # Append by page name
notion-cli append "Meeting Notes" "## Action Items\n\n- Fix bug" # Markdown content
cat notes.md | notion-cli append "Knowledge Hub"                # Pipe from file
notion-cli a "Daily Log" "Quick note"                           # Short alias

📖 Append Reference

Search

notion-cli search "project" --json                    # Search workspace
notion-cli search "docs" -p page --json               # Filter by type
notion-cli search "report" --created-after 2025-10-01 # Date filters

User Commands

notion-cli user list --json           # List all users
notion-cli user retrieve <USER_ID>    # Get user
notion-cli user retrieve bot          # Get bot info

Stats Dashboard

notion-cli stats                      # Workspace overview from cache (instant)
notion-cli stats --live               # Also fetch page counts per DB (slower)
notion-cli stats --relations          # Show database relation graph
notion-cli stats --json               # JSON output for automation
notion-cli dashboard                  # Alias

📖 Stats Reference

Workspace & Cache

notion-cli sync                       # Cache all databases
notion-cli list --json                # List cached databases
notion-cli cache:info --json          # Cache statistics
notion-cli config set-token           # Configure token
notion-cli browse <PAGE_ID>          # Interactive page tree navigation

Output Formats

All commands support multiple output formats:

notion-cli db query <ID> --json          # Structured JSON with envelope
notion-cli db query <ID> --compact-json  # Single-line JSON (ideal for piping)
notion-cli db query <ID> --markdown      # GitHub-flavored markdown table
notion-cli db query <ID> --pretty        # Table with borders
notion-cli db query <ID> --csv           # CSV format
notion-cli db query <ID> --raw           # Raw API response
notion-cli db query <ID> --minimal       # Strip metadata (~40% smaller)

📖 Output Formats Guide | 📖 Envelope System

Environment Variables

Authentication

NOTION_TOKEN=secret_your_token_here    # Internal integration token
# or
NOTION_TOKEN=ntn_your_token_here       # OAuth token (newer format)

Retry & Circuit Breaker

NOTION_RETRY_MAX_ATTEMPTS=3        # Max retry attempts (default: 3)
NOTION_RETRY_INITIAL_DELAY=1000    # Initial delay in ms (default: 1000)
NOTION_RETRY_MAX_DELAY=30000       # Max delay in ms (default: 30000)
NOTION_CB_FAILURE_THRESHOLD=5      # Failures before circuit opens (default: 5)

Caching & Performance

NOTION_CACHE_DISABLED=true                    # Disable all caching
NOTION_CLI_DISK_CACHE_ENABLED=true            # Persistent disk cache (default: true)
NOTION_CLI_DISK_CACHE_MAX_SIZE=104857600      # Max disk cache size (default: 100MB)
NOTION_CLI_HTTP_KEEP_ALIVE=true               # Connection pooling (default: true)
NOTION_CLI_DELETE_CONCURRENCY=5               # Parallel deletion limit (default: 5)

Debugging

NOTION_CLI_VERBOSE=true            # Structured event logging to stderr
NOTION_CLI_DEBUG=true              # DEBUG + VERBOSE modes
NO_COLOR=1                         # Disable ANSI color codes in tables

📖 Verbose Logging Guide

Real-World Examples

Automated Task Management

#!/bin/bash
# Create task with simple properties
TASK_ID=$(notion-cli page create \
  -d <TASKS_DB_ID> -S --properties '{
    "Name": "Review PR",
    "Status": "In Progress"
  }' --json | jq -r '.data.id')

echo "Working on task: $TASK_ID"

# Mark complete
notion-cli page update $TASK_ID -S --properties '{"Status": "Done"}' --json

Daily Sync Script

#!/bin/bash
notion-cli sync
notion-cli list --json > databases.json
echo "# Database Report - $(date)" > report.md
jq -r '.[] | "- **\(.title)** (\(.page_count) pages)"' databases.json >> report.md

Troubleshooting

Run diagnostics first:

notion-cli doctor   # Shows 7 checks with pass/fail and recommendations
Problem Solution
Token not configured notion-cli init or export NOTION_TOKEN="secret_..." (or "ntn_...")
Database not found notion-cli sync to refresh cache, or check ID type
429 rate limiting Automatic retry handles this; increase NOTION_RETRY_MAX_ATTEMPTS if needed
Slow queries Use --filter to reduce data, notion-cli sync for caching
Auth errors notion-cli init to reconfigure, check integration access at notion.so/my-integrations

Development

Prerequisites

  • Node.js >= 22.0.0
  • npm >= 8.0.0

Setup

git clone https://github.com/Catafal/notion-cli
cd notion-cli
npm install
npm run build

Workflow

npm run build          # Build TypeScript
npm test               # Run tests (mocha + chai)
npm run lint           # Lint (ESLint v9)
npm run build && npm test && npm run lint   # Full quality check

Project Structure

notion-cli/
├── src/               # TypeScript source
│   ├── commands/      # CLI commands
│   ├── utils/         # Utilities
│   ├── notion.ts      # Notion API client
│   └── cache.ts       # Caching layer
├── test/              # Tests
├── docs/              # Documentation
└── dist/              # Compiled output

See CONTRIBUTING.md for guidelines.

Documentation

Full documentation lives in the /docs folder:

See docs/README.md for the complete index.

Contributing

Contributions welcome! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Add tests for new features
  4. Submit a pull request

See CONTRIBUTING.md for code style, test requirements, PR process, and commit format.

API Version

This CLI uses Notion API v5.2.1 with full support for:

  • Data sources (new database API)
  • Enhanced properties
  • Improved pagination
  • Better error handling

Support

Related Projects

Legal & Compliance

Trademark Notice

"Notion" is a registered trademark of Notion Labs, Inc. This project is an independent, unofficial tool and is not affiliated with, endorsed by, or sponsored by Notion Labs, Inc.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Third-Party Licenses

This project uses various open-source dependencies. See NOTICE for complete third-party license information.

Built for AI agents, optimized for automation.

About

No description, website, or topics provided.

Resources

Readme

License

MIT license

Contributing

Contributing

Security policy

Security policy
Activity

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages