Getting started

research qiita

orc research qiita finds articles with native Qiita search expressions and follows tags or users to public articles and comments. Inspect trends or native rankings, then use item IDs to retrieve articles.

Authenticate the CLI and select an accessible Workspace. Use --workspace to set the scope for this call.

Usage

terminal
orc research qiita items list --query "tag:Python" --per-page 20 --workspace <workspace-id> --json

Find articles tagged Python.

Subcommands

items list

List Qiita articles and filter them with native expressions such as tag:Python in --query.

terminal
orc research qiita items list [options]

Unique options

--page

Qiita API v2 page number, 1–100.

Type: number. Optional.

terminal
orc research qiita items list --page <value>
--per-page

Requested items per page, 1–100.

Type: number. Optional.

terminal
orc research qiita items list --per-page <value>
--include-native

Include original source list fields. Detail endpoints always include native data.; enum: true|false

Type: string. Optional.

terminal
orc research qiita items list --include-native <value>
--query

Native Qiita item search expression.; max 1000 chars

Type: string. Optional.

terminal
orc research qiita items list --query <value>

items get

Retrieve an article using its 20-character item ID, not its URL.

terminal
orc research qiita items get <id> [options]

items comments list

Retrieve comments for an item ID.

terminal
orc research qiita items comments list <id> [options]

map

Discover Qiita operations for articles, tags and users.

terminal
orc research qiita map [options]

rankings tags list

Retrieve weekly or monthly tag rankings in the source’s native order and window.

terminal
orc research qiita rankings tags list [options]

Unique options

--scope

Native Qiita ranking period. all is available for users only.; enum: weekly|monthly

Type: string. Optional.

terminal
orc research qiita rankings tags list --scope <value>

rankings users list

Retrieve weekly, monthly or all-time user rankings. Available periods differ from tag rankings.

terminal
orc research qiita rankings users list [options]

Unique options

--scope

Native Qiita ranking period. all is available for users only.; enum: weekly|monthly|all

Type: string. Optional.

terminal
orc research qiita rankings users list --scope <value>

tags list

Browse tags. Use --sort count for item counts or --sort name for names; omission uses Qiita’s newest order.

terminal
orc research qiita tags list [options]

Unique options

--page

Qiita API v2 page number, 1–100.

Type: number. Optional.

terminal
orc research qiita tags list --page <value>
--per-page

Requested items per page, 1–100.

Type: number. Optional.

terminal
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

Type: string. Optional.

terminal
orc research qiita tags list --sort <value>

tags get

Retrieve public information for a tag name.

terminal
orc research qiita tags get <id> [options]

tags items list

Retrieve one page of articles associated with a tag.

terminal
orc research qiita tags items list <id> [options]

Unique options

--page

Qiita API v2 page number, 1–100.

Type: number. Optional.

terminal
orc research qiita tags items list <id> --page <value>
--per-page

Requested items per page, 1–100.

Type: number. Optional.

terminal
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

Type: string. Optional.

terminal
orc research qiita tags items list <id> --include-native <value>

Retrieve articles appearing in Qiita’s native trends.

terminal
orc research qiita trends list [options]

Unique options

--include-native

Include original source list fields. Detail endpoints always include native data.; enum: true|false

Type: string. Optional.

terminal
orc research qiita trends list --include-native <value>

users get

Retrieve a public profile by username rather than permanent_id.

terminal
orc research qiita users get <id> [options]

users items list

List public articles by username.

terminal
orc research qiita users items list <id> [options]

Unique options

--page

Qiita API v2 page number, 1–100.

Type: number. Optional.

terminal
orc research qiita users items list <id> --page <value>
--per-page

Requested items per page, 1–100.

Type: number. Optional.

terminal
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

Type: string. Optional.

terminal
orc research qiita users items list <id> --include-native <value>

Examples

Read tag rankings.

terminal
orc research qiita rankings tags list --scope weekly --workspace <workspace-id> --json

Read tag rankings.

Output and continuation

List calls retrieve one source page. Follow the query values in pagination.next_url using the corresponding flags, keeping filters unchanged. Unknown continuation does not establish completeness. Automatic traversal with --page-all is unavailable.

With --json, the full API response is retained inside the CLI data envelope. Records are in data.data, continuation in data.pagination, and provenance in data.source. --raw removes the CLI envelope; --field data selects API data. Missing and null values do not mean zero.

Search and page settings

Article searches accept native Qiita expressions. --page ranges from 1 to 100; --per-page ranges from 1 to 100 and defaults to 20. Use --include-native true for original list fields; detail responses always include native data. Rankings retain the source window and size without an exhaustive-coverage guarantee.

Permissions

API keys require read scope. Provider credentials are managed by the server.

Global Options

The following global options can be used with orc research qiita:

For details and examples, see global options.