superflow-cli
v0.4.0
Published
SuperFlow CLI — 保存したミニブックを検索・出力し、AI エージェントへ素材として渡す(Pro)
Readme
SuperFlow CLI
保存したミニブックを検索・出力し、Markdown でパイプして AI エージェント(Claude Code / Codex)へ素材として渡す(Pro 想定)。依存ゼロ(Node 18+ 組み込みのみ)。
コマンドは superflow と短縮エイリアス sf のどちらでも実行できる。
インストール
npm install -g superflow-cliローカル開発時は cd cli && npm install -g .(もしくは npm link)。
AI エージェント(Claude Code / Codex 等)にセットアップを任せるなら、次のURLを渡せばインストールから認証まで案内される: https://super-flow.ai/cli-install.md
使い方
superflow login # トークン発行+認証確認(solo モードはブラウザ不要)
superflow list [--unread|--read] [--limit N]
superflow recent [--limit N] # 直近 N 件(既定10)
superflow search "<query>" [--starred] [--tag T] [--since 7d|24h] [--only ...]
superflow read <id> [--only summary|highlight|memo]
superflow highlights [--format=json] # 全書籍のハイライトを集約出力
superflow export # 全件を Markdown でエクスポート
superflow open <id> # Web 版で開く
superflow token list # CLI トークン一覧
superflow token revoke <id> [--yes] # トークンを失効
superflow doctor # 接続先・認証の疎通確認
superflow version # バージョン表示(--version / -v も可)--format=json で JSON 出力(パイプ時は自動でJSON)。--format=md でパイプ時もMarkdownで出力(明示指定が最優先)。<id> は先頭数文字の短縮IDでも可(一意に定まる場合)。
例
superflow search "AI" | claude code "これを元に note の下書きを作って"
superflow read <id> --only highlight,memo # 自分が触れた痕跡だけ
superflow read <id> --format=md | claude code "この素材から下書きを作って"
superflow read <id> --format=json | jq .provenance(出所を偽らない)
SuperFlow は「読む人のための外脳」。外脳は出所を偽らない。read / search は 1 冊の中身を 3 つの出所に区別 して出力する。
- 要約(AI要約・原文未接触) … AI が生成した要約本文と主要ポイント。あなたが原文で触れた箇所ではない。
- 引用(原文で選択したハイライト) … あなたが原文で選択したハイライト。
- メモ(あなたの言葉) … あなた自身が書いたメモ。
--only で出所を絞れる(カンマ区切り可)。値は summary / highlight / memo。
superflow read <id> --only summary # AI要約だけ
superflow read <id> --only highlight,memo # 自分が触れた痕跡だけ
superflow search "AI" --only memo # メモを対象に検索設定
- 設定ファイル:
~/.superflow/config.json({ endpoint, token }、パーミッション0600/ ディレクトリ0700) - 既定接続先:
https://super-flow.ai
環境変数
SUPERFLOW_TOKEN… トークン(config.jsonの token より優先)SUPERFLOW_ENDPOINT… 接続先 URL の上書きSUPERFLOW_NO_BROWSER=1…loginでブラウザを自動で開かない(認証URLは表示され、自動受け渡しは有効)SF_JSON=1… 常に JSON 出力
認証
- solo モード(DB あり・認証 off):
superflow loginが/api/cli/tokenを直接叩いてトークンを発行(ブラウザ認証不要)。 - 多人数モード(Supabase認証): ブラウザ認証を自動で受け渡す(コピペ不要)。
superflow loginを実行するとブラウザが開く(開かない場合は表示された認証URLを開く)。- ブラウザで SuperFlow にログインする。
- 「接続を許可」を押すと、トークンが手元の CLI へ自動で戻り、そのまま自動で完了する。
- CLI はローカルの
127.0.0.1:<ランダムポート>で待ち受け、stateを照合して受け取る。ブラウザには「✓ 認証完了」と表示されるので、タブを閉じてターミナルに戻ればよい。 - 手動で貼り付けたい場合は、CLI のプロンプトにトークンを貼り付けて Enter でも完了できる。
SUPERFLOW_NO_BROWSER=1を付けると自動でブラウザを開かない(SSH・CI 向け)。表示された認証URLを別端末のブラウザで開けば、そのまま自動受け渡しが働く。
- ログイン後は
/api/cli/tokenで認証確認してから成功を表示する。接続や認証が怪しいときはsuperflow doctorで診断できる。
