research qiita
orc research qiita は、Qiitaの検索式を使って記事を探し、タグ・ユーザーから公開記事やコメントをたどるコマンドです。トレンドや原典のランキングを取得し、記事IDから本文を確認できます。
認証済みのCLIと、アクセス可能なWorkspaceが必要です。--workspace で今回の対象を指定できます。
使い方
orc research qiita items list --query "tag:Python" --per-page 20 --workspace <workspace-id> --jsonPythonタグの記事を取得する。
サブコマンド
items list
Qiitaの記事を一覧表示し、--query に tag:Python などのQiita検索式を指定して絞り込めます。
orc research qiita items list [options]固有のオプション
--page
Qiita API v2 page number, 1–100.
型: number。任意。
orc research qiita items list --page <value>--per-page
Requested items per page, 1–100.
型: number。任意。
orc research qiita items list --per-page <value>--include-native
Include original source list fields. Detail endpoints always include native data.; enum: true|false
型: string。任意。
orc research qiita items list --include-native <value>--query
Native Qiita item search expression.; max 1000 chars
型: string。任意。
orc research qiita items list --query <value>items get
20文字の記事IDを指定して記事を取得します。URLは位置引数に渡しません。
orc research qiita items get <id> [options]items comments list
記事IDを指定して記事のコメントを取得します。
orc research qiita items comments list <id> [options]map
Qiitaの取得機能と記事・タグ・ユーザーの入口を確認します。
orc research qiita map [options]週次または月次のタグランキングを取得します。掲載期間と並び順はQiitaが決めます。
orc research qiita rankings tags list [options]固有のオプション
--scope
Native Qiita ranking period. all is available for users only.; enum: weekly|monthly
型: string。任意。
orc research qiita rankings tags list --scope <value>rankings users list
週次・月次・全期間のユーザーランキングを取得します。タグランキングと対応期間が異なります。
orc research qiita rankings users list [options]固有のオプション
--scope
Native Qiita ranking period. all is available for users only.; enum: weekly|monthly|all
型: string。任意。
orc research qiita rankings users list --scope <value>タグを一覧表示します。--sort count は記事数、--sort name は名前順で取得し、省略時はQiitaの新しい順を使います。
orc research qiita tags list [options]固有のオプション
--page
Qiita API v2 page number, 1–100.
型: number。任意。
orc research qiita tags list --page <value>--per-page
Requested items per page, 1–100.
型: number。任意。
orc research qiita tags list --per-page <value>--sort
Native tag ordering by item count or name. Omit to use Qiita newest order.; enum: count|name
型: string。任意。
orc research qiita tags list --sort <value>タグ名を指定して公開情報を取得します。
orc research qiita tags get <id> [options]タグ名に関連する記事を一ページ取得します。
orc research qiita tags items list <id> [options]固有のオプション
--page
Qiita API v2 page number, 1–100.
型: number。任意。
orc research qiita tags items list <id> --page <value>--per-page
Requested items per page, 1–100.
型: number。任意。
orc research qiita tags items list <id> --per-page <value>--include-native
Include original source list fields. Detail endpoints always include native data.; enum: true|false
型: string。任意。
orc research qiita tags items list <id> --include-native <value>trends list
Qiitaが掲載するトレンド記事を取得します。
orc research qiita trends list [options]固有のオプション
--include-native
Include original source list fields. Detail endpoints always include native data.; enum: true|false
型: string。任意。
orc research qiita trends list --include-native <value>users get
usernameを指定して公開プロフィールを取得します。permanent_id は使いません。
orc research qiita users get <id> [options]users items list
usernameを指定して、そのユーザーの公開記事を一覧表示します。
orc research qiita users items list <id> [options]固有のオプション
--page
Qiita API v2 page number, 1–100.
型: number。任意。
orc research qiita users items list <id> --page <value>--per-page
Requested items per page, 1–100.
型: number。任意。
orc research qiita users items list <id> --per-page <value>--include-native
Include original source list fields. Detail endpoints always include native data.; enum: true|false
型: string。任意。
orc research qiita users items list <id> --include-native <value>使用例
タグランキングを取得する。
orc research qiita rankings tags list --scope weekly --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として扱わないでください。
検索とページ条件
記事はQiitaの検索式で探せます。--page は1〜100、--per-page は1〜100件で既定20件です。一覧に原典フィールドを含める場合は --include-native true を指定し、詳細取得には常に原典データが含まれます。ランキングは原典の期間・件数であり、全件取得を保証しません。
必要な権限
APIキーではreadスコープが必要です。 プロバイダーのキーはサーバー側で管理します。
グローバルオプション
orc research qiita では、次のグローバルオプションを使用できます。
各オプションの詳細と使用例は、グローバルオプションを参照してください。