research note
orc research note は、noteの記事を検索し、作者・ハッシュタグ・トピックから公開記事を探すコマンドです。発見した記事IDから本文やコメントを取得し、作者プロフィールを確認できます。
認証済みのCLIと、アクセス可能なWorkspaceが必要です。--workspace で今回の対象を指定できます。
使い方
orc research note articles search --q "生成AI" --workspace <workspace-id> --json公開記事を検索する。
サブコマンド
articles search
--q の語句でnoteの記事を検索します。発見した記事IDを使い、本文やコメントを個別に取得できます。
orc research note articles search [options]固有のオプション
--q
Search text; 1–200 characters. URL-encode when building a request.; max 200 chars
型: string。必須。
orc research note articles search --q <value>--sort
Native note ordering: popular, newest, or hot.; enum: popular|new|hot
型: string。任意。
orc research note articles search --sort <value>--start
Use pagination.next_start from the previous response; keep other search parameters unchanged.; (use "null" or "reset" to clear)
型: number。任意。
orc research note articles search --start <value>--paid
true selects the source sales collection; it does not unlock paid bodies.; enum: true|false
型: string。任意。
orc research note articles search --paid <value>articles get
記事IDを指定してnoteの記事を取得します。URLではなく一覧にあるIDを使います。
orc research note articles get <id> [options]creators get
作者のnameを指定して公開プロフィールを取得します。記事一覧の作者情報から対象を選べます。
orc research note creators get <name> [options]ハッシュタグ名を指定して、そのタグの公開情報を取得します。
orc research note hashtags get <name> [options]ハッシュタグ名に関連する記事を一ページ取得します。
orc research note hashtags articles list <name> [options]固有のオプション
--page
One-based native page number; use the returned continuation.
型: number。任意。
orc research note hashtags articles list <name> --page <value>interests get
関心分野のnameを指定して公開情報を取得します。
orc research note interests get <name> [options]固有のオプション
--page
One-based native page number; use the returned continuation.
型: number。任意。
orc research note interests get <name> --page <value>map
noteのトピックや取得機能の入口を確認します。返されたトピックのpathを topics get に指定できます。
orc research note map [options]タグ名を指定してタグの公開情報を取得します。
orc research note tags get <name> [options]固有のオプション
--mode
Native tag ordering. Keep the mode unchanged when following the returned cursor; switching it starts a different collection.; enum: popular|new
型: string。任意。
orc research note tags get <name> --mode <value>topics get
map で確認したトピックのpathを --path へ渡し、そのトピックを取得します。階層を持つpathにも対応します。
orc research note topics get [options]固有のオプション
--page
One-based page within the selected topic and tab. Use the returned continuation; some curated layouts only expose their initial page.
型: number。任意。
orc research note topics get --page <value>--tab
Native topic tab identifier. Follow api_url in data.pages to select a tab. When omitted, the source top tab is selected.
型: string。任意。
orc research note topics get --tab <value>--path
Topic ID from map; nested paths are supported.; max 200 chars
型: string。必須。
orc research note topics get --path <value>trends list
noteが掲載するトレンドのセクションを取得します。原典の掲載範囲と順序を保持します。
orc research note trends list [options]固有のオプション
--page
One-based native page number; use the returned continuation.
型: number。任意。
orc research note trends list --page <value>articles comments list
指定記事のコメントを一ページ取得します。続きを取得するときは対象記事と検索条件を維持してください。
orc research note articles comments list <id> [options]固有のオプション
--page
One-based native page number; use the returned continuation.
型: number。任意。
orc research note articles comments list <id> --page <value>creators articles list
作者のnameを指定して公開記事を一覧表示します。表示名ではなく取得元の作者識別子を使います。
orc research note creators articles list <name> [options]固有のオプション
--page
One-based native page number; use the returned continuation.
型: number。任意。
orc research note creators articles list <name> --page <value>使用例
トピックの公開情報を取得する。
orc research note topics get --path challenge --workspace <workspace-id> --jsonトピックの公開情報を取得する。
ハッシュタグの情報を取得する。
orc research note hashtags get "生成AI" --workspace <workspace-id> --jsonハッシュタグの情報を取得する。
出力とページ送り
一覧は一回の呼び出しで一ページを取得します。返された pagination.next_url のクエリ値を、対応するフラグへ渡して続きを取得してください。検索条件は維持します。継続情報が不明でも全件取得済みとは判断せず、--page-all による自動巡回は行いません。
--json ではAPIレスポンス全体をCLIの data に保持します。取得内容は data.data、継続情報は data.pagination、取得元情報は data.source です。--raw はCLIの外枠を外し、--field data はAPIのデータだけを選択します。欠損値やnullを0として扱わないでください。
必要な権限
APIキーではreadスコープが必要です。 プロバイダーのキーはサーバー側で管理します。
グローバルオプション
orc research note では、次のグローバルオプションを使用できます。
各オプションの詳細と使用例は、グローバルオプションを参照してください。