note-research-cli

noteの競合調査と下書き作成/更新を行うCLIです。

[!WARNING] このツールは 非公式APIを利用しています。 note公式サービスとは無関係です。利用者自身の責任で利用規約を確認してください。

Status

• Scope: Research + draft create/update
• Out of scope: publish/public/post
• Support: Community support only

Credits

This project is derived from:

• Original repository: https://github.com/shimayuz/note-com-mcp
• Original license: MIT
• See NOTICE for details.

Features

• Search notes/users
• Competitor analysis and diff reports
• Account analysis: analyze content trends of a specific user (user analyze)
• Draft create/update
• Minimal-first JSON / Markdown outputs (--profile full for raw payload)

Requirements

• Node.js 20+ (LTS recommended)
• npm 10+

Install

npm install -g note-research-cli

Authentication

推奨: 環境変数経由で設定する（コマンドライン引数はプロセス一覧に露出するリスクがあります）

# .env ファイルに記載（git管理外にすること）
NOTE_SESSION_V5=<セッション値のみ。_note_session_v5= は不要>
NOTE_XSRF_TOKEN=<xsrfトークン>

Interactive login (recommended)

auth login は対話式です。モード選択でログイン導線を切り替えられます。

note-research auth login

Browser mode (Playwright)

Playwrightがインストール済みなら、ブラウザログイン補助を使えます。

npm install -g playwright
npx playwright install chromium
note-research auth login --browser

Manual mode

note-research auth login --cookie "_note_session_v5=..."
note-research auth status

--xsrf は省略可能です（未指定時は自動取得を試行）。

Environment mode

note-research auth login --mode env

Safer non-interactive input

引数露出を避けるため、cookie は標準入力でも渡せます。

echo "_note_session_v5=..." | note-research auth login --cookie-stdin --manual

認証情報は ~/.note-research/session.json (mode 0600) に保存されます。

Usage

note-research search-notes --query "AI" --format json
note-research search-notes --query "AI" --format json --profile full
note-research competitor analyze --query "AI" --format json
note-research report needs --query "AI" --format md
note-research user analyze --user <urlname> --format json
note-research draft create --title "test" --body-file ./draft.md --format json

Output Profile

• Default: --profile minimal
• Optional: --profile full

minimal はエージェント実行向けにノイズを削った出力です。 full はデバッグ・互換用途で生データ寄りの出力を維持します。

Known Limitations

• Uses unofficial endpoints that may change without notice
• Authentication/session behavior may vary by account state
• Automatic workflows can break when endpoint contracts change

Security

• Never commit .env or session cookies
• Keep account tokens private
• Rotate credentials if leaked
• Prefer environment variables (NOTE_SESSION_V5) over --cookie CLI arguments to avoid session exposure in process listings (ps aux)
• Session file is stored at ~/.note-research/session.json with permissions 0600 (owner-read/write only)

License

MIT