mcpField
N
notion-cli

notion-cli

github.com/makenotion生产力1778.8k 次安装5 周前更新
代码仓库

关于 notion-cli

面向 Notion 用户的命令行工具使用指南，涵盖 API 查询、页面与文件操作及 workers 管理。它强调先读取 CLI 自带文档，并说明令牌与登录认证方式。

主要功能

  1. 01查询 API 端点与官方文档
  2. 02读取 Markdown 页面内容
  3. 03创建或更新页面与评论
  4. 04管理文件上传
  5. 05部署和执行 Notion workers

适用场景

  1. 01查找 API 方法与请求参数
  2. 02读取或编辑 Notion 页面
  3. 03上传文件并管理 workers

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/makenotion/skills --skill notion-cli

安装后在 Claude Code 中输入/notion-cli确认已加载。

附带文件LICENSE.md

详细介绍

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

身份验证

  • 设置 NOTION_API_TOKEN 后，CLI 会自动使用它。
  • 请先检查 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 和评论

页面内容请优先使用 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 workers（部署、列出、执行等）。运行 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

评论

支持 Markdown