notion-cli

Notion CLI

回答する前に情報を確認する

この CLI は自己ドキュメント化されています。構文を推測したり、記憶した知識に頼ったりするのではなく、必ず次のコマンドを実行してください。

• ntn api ls — すべての公開 API エンドポイントを一覧表示します。
• ntn api <path> --help — エンドポイントのメソッド、ドキュメントへのリンク、使用方法を表示します。
• ntn api <path> --docs — エンドポイントの公式ドキュメント全文を出力します。
• ntn api <path> --spec — 簡略化された OpenAPI フラグメントを出力します（リクエスト／レスポンスのスキーマの確認に便利です）。
• ntn pages get <page-id> — ページを Markdown として取得します。ページの内容を読むときに使用してください。
• ntn <command> --help — 任意のコマンドまたはサブコマンドのヘルプを表示します。

インストール

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

認証

• CLI は、NOTION_API_TOKEN が設定されている場合、自動的にそれを使用します。
• まず NOTION_API_TOKEN を確認してください。すでに設定されている場合は、ユーザーに ntn login の実行を案内するのではなく、そちらを優先して使用してください。
• ntn login / ntn logout — CLI にログインまたはログアウトします（NOTION_API_TOKEN を使用していない場合にのみ使用してください）。ntn login を実行するには、ユーザーが Web ブラウザーで URL にアクセスする必要があります。

ntn api

構文の詳細については、ntn api --help を実行してください。概要は次のとおりです。

# GET with query param
ntn api v1/users page_size==100

# POST with inline body fields
ntn api v1/pages parent[page_id]=abc123

# POST with JSON body
ntn api v1/pages -d '{"parent":{"page_id":"abc123"}}'

メソッドは自動的に判定されます（デフォルトは GET、本文がある場合は POST）。-X METHOD で上書きできます。

ページとコメントの Markdown

Markdown のページコンテンツには、ntn pages create / ntn pages update を優先して使用してください。ntn api を使用してコメントを作成または更新する場合は、markdown フィールドを使用してください。

# Comment with markdown
ntn api v1/comments -d '{"parent":{"page_id":"abc123"},"markdown":"Here is a [link](https://example.com) and **bold text**."}'

# Page with markdown body
ntn pages create --parent page:abc123 --content '## Heading\n\nSome *formatted* content.'

markdown フィールドは、インライン書式（太字、斜体、コード、リンクなど）に対応しています。Markdown で表現できない機能（メンション、カスタム絵文字、色など）が必要な場合に限り、rich_text を使用してください。

ntn files

File Uploads API の便利なラッパーです。

ntn files create < image.png
ntn files create --external-url https://example.com/photo.png
ntn files list
ntn files get <upload-id>

ntn workers

Notion のワーカーを管理します（デプロイ、一覧表示、実行など）。サブコマンドについては、ntn workers --help を実行してください。

ntn workers new my-worker        # scaffold a new project
ntn workers deploy               # deploy from current directory
ntn workers ls                   # list workers
ntn workers exec <capability>    # execute a capability