Getting started

research zenn

orc research zenn searches Zenn articles, books and scraps by author, topic or publication. Follow owner and slug values to retrieve details, and inspect search counts or homepage sections.

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

Usage

terminal
orc research zenn articles list --q "生成AI" --workspace <workspace-id> --json

Find articles about a topic.

Subcommands

articles list

Search articles and filter by author, topic, publication and native order. --publication-name uses the publication name, not its display name.

terminal
orc research zenn articles list [options]

Unique options

--q

Search text, 1–200 characters. Uses Zenn keyword search; content ordering is controlled by order.; max 200 chars

Type: string. Optional.

terminal
orc research zenn articles list --q <value>
--page

One-based page number. Prefer the returned pagination.next_url.

Type: number. Optional.

terminal
orc research zenn articles list --page <value>
--topic-name

Zenn topic name, not its numeric ID. URL-encode the path segment.; max 200 chars

Type: string. Optional.

terminal
orc research zenn articles list --topic-name <value>
--username

Filter by the Zenn author username.

Type: string. Optional.

terminal
orc research zenn articles list --username <value>
--order

Native Zenn order. Defaults to latest. daily is Trending; alltime is Alltime; recent is Recent. Scraps do not support recent.; enum: latest|daily|alltime|recent

Type: string. Optional.

terminal
orc research zenn articles list --order <value>
--publication-name

Filter articles by publication name, not display name.

Type: string. Optional.

terminal
orc research zenn articles list --publication-name <value>

articles get

Retrieve an article using the owner and slug from its URL or returned api_url, rather than a numeric ID.

terminal
orc research zenn articles get <owner> <slug> [options]

books list

Search books and filter by author, topic and native order.

terminal
orc research zenn books list [options]

Unique options

--q

Search text, 1–200 characters. Uses Zenn keyword search; content ordering is controlled by order.; max 200 chars

Type: string. Optional.

terminal
orc research zenn books list --q <value>
--page

One-based page number. Prefer the returned pagination.next_url.

Type: number. Optional.

terminal
orc research zenn books list --page <value>
--topic-name

Zenn topic name, not its numeric ID. URL-encode the path segment.; max 200 chars

Type: string. Optional.

terminal
orc research zenn books list --topic-name <value>
--username

Filter by the Zenn author username.

Type: string. Optional.

terminal
orc research zenn books list --username <value>
--order

Native Zenn order. Defaults to latest. daily is Trending; alltime is Alltime; recent is Recent. Scraps do not support recent.; enum: latest|daily|alltime|recent

Type: string. Optional.

terminal
orc research zenn books list --order <value>

books get

Retrieve a book using the owner and slug from its URL or returned api_url, rather than a numeric ID.

terminal
orc research zenn books get <owner> <slug> [options]

map

Discover Zenn retrieval operations and content entry points.

terminal
orc research zenn map [options]

publications list

Search publications using the required --q search text.

terminal
orc research zenn publications list [options]

Unique options

--q

Search text, 1–200 characters. Uses Zenn keyword search; content ordering is controlled by order.; max 200 chars

Type: string. Required.

terminal
orc research zenn publications list --q <value>
--page

One-based page number. Prefer the returned pagination.next_url.

Type: number. Optional.

terminal
orc research zenn publications list --page <value>

publications get

Retrieve a publication by its name, not its display name or numeric ID.

terminal
orc research zenn publications get <name> [options]

scraps list

Search scraps by author or topic. Supported order values are latest, daily and alltime; scraps do not support recent.

terminal
orc research zenn scraps list [options]

Unique options

--q

Search text, 1–200 characters. Uses Zenn keyword search; content ordering is controlled by order.; max 200 chars

Type: string. Optional.

terminal
orc research zenn scraps list --q <value>
--page

One-based page number. Prefer the returned pagination.next_url.

Type: number. Optional.

terminal
orc research zenn scraps list --page <value>
--topic-name

Zenn topic name, not its numeric ID. URL-encode the path segment.; max 200 chars

Type: string. Optional.

terminal
orc research zenn scraps list --topic-name <value>
--username

Filter by the Zenn author username.

Type: string. Optional.

terminal
orc research zenn scraps list --username <value>
--order

Native scrap ordering: latest, daily or alltime. Defaults to latest. Keep the value unchanged when following pagination.; enum: latest|daily|alltime

Type: string. Optional.

terminal
orc research zenn scraps list --order <value>

scraps get

Retrieve a scrap using the owner and slug from its URL or returned api_url, rather than a numeric ID.

terminal
orc research zenn scraps get <owner> <slug> [options]

search counts get

Retrieve source search counts for --q. Counts do not measure search demand or article quality.

terminal
orc research zenn search counts get [options]

Unique options

--q

Search text, 1–200 characters. Uses Zenn keyword search; content ordering is controlled by order.; max 200 chars

Type: string. Required.

terminal
orc research zenn search counts get --q <value>

topics list

Browse topics using search text and page numbers.

terminal
orc research zenn topics list [options]

Unique options

--q

Search text, 1–200 characters. Uses Zenn keyword search; content ordering is controlled by order.; max 200 chars

Type: string. Optional.

terminal
orc research zenn topics list --q <value>
--page

One-based page number. Prefer the returned pagination.next_url.

Type: number. Optional.

terminal
orc research zenn topics list --page <value>

topics get

Retrieve a topic by name rather than numeric ID.

terminal
orc research zenn topics get <name> [options]

Retrieve sections displayed on the Zenn homepage.

terminal
orc research zenn trends list [options]

users list

Search Zenn users using the required --q search text.

terminal
orc research zenn users list [options]

Unique options

--q

Search text, 1–200 characters. Uses Zenn keyword search; content ordering is controlled by order.; max 200 chars

Type: string. Required.

terminal
orc research zenn users list --q <value>
--page

One-based page number. Prefer the returned pagination.next_url.

Type: number. Optional.

terminal
orc research zenn users list --page <value>

users get

Retrieve public information for a Zenn username.

terminal
orc research zenn users get <name> [options]

Examples

Retrieve an article using its URL identifiers.

terminal
orc research zenn articles get <owner> <slug> --workspace <workspace-id> --json

Retrieve an article using its URL identifiers.

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.

Identifiers and native order

For details, owner is the first source URL segment and slug is the content slug. Use topic names, usernames and publication names rather than numeric IDs or display names. Articles and books support latest, daily, alltime and recent; scraps do not support recent. Preserve ordering when continuing.

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 zenn:

For details and examples, see global options.