Skip to content

Commit f170bc2

Browse files
docs: regenerate command docs
1 parent d76b4f2 commit f170bc2

23 files changed

Lines changed: 756 additions & 38 deletions

‎docs/modapi.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,15 @@ modapi [flags]
3838

3939
* [modapi account](modapi_account.md) - Operations for account
4040
* [modapi actions](modapi_actions.md) - Operations for actions
41+
* [modapi analytics](modapi_analytics.md) - Operations for analytics
4142
* [modapi auth](modapi_auth.md) - Manage authentication credentials
4243
* [modapi authors](modapi_authors.md) - Operations for authors
4344
* [modapi channels](modapi_channels.md) - Operations for channels
4445
* [modapi configure](modapi_configure.md) - Configure authentication credentials and preferences
4546
* [modapi content](modapi_content.md) - Operations for content
4647
* [modapi doctor](modapi_doctor.md) - Check the Moderation API setup of this project
4748
* [modapi explore](modapi_explore.md) - Interactively browse and run commands
49+
* [modapi feedback](modapi_feedback.md) - Operations for feedback
4850
* [modapi init](modapi_init.md) - Set up Moderation API in this project
4951
* [modapi link](modapi_link.md) - Connect this directory to an existing Moderation API project
5052
* [modapi login](modapi_login.md) - Sign in with your Moderation API account

‎docs/modapi_analytics.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## modapi analytics
2+
3+
Operations for analytics
4+
5+
### Synopsis
6+
7+
Operations for analytics
8+
9+
```
10+
modapi analytics [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for analytics
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
--agent-mode Enable structured errors and default TOON output for AI coding agents. Automatically enabled when a known agent environment is detected (CLAUDECODE, CURSOR_AGENT, etc.). Use --agent-mode=false to disable.
23+
--color string Control colored output: auto (color when output is a TTY), always, or never. Respects NO_COLOR and FORCE_COLOR env vars. (default "auto")
24+
-d, --debug Log request and response diagnostics to stderr
25+
--dry-run Preview API requests without sending them (no network, no OS keychain). Human preview on stderr; with -o json or --jq, one JSON object per request on stdout. Local mutation commands (auth login, auth logout and configure) make no request: they skip prompts and writes and report a no-op (stderr, or one JSON object on stdout in the machine form)
26+
-H, --header stringArray Set a custom HTTP request header (format: "Key: Value"). Can be specified multiple times.
27+
--include-headers Include HTTP response headers in the output
28+
--interactive Prompt for missing inputs and open guided configure/auth forms (forms fall back to line prompts on stdin off-TTY) (default true)
29+
-q, --jq string Filter and transform output using a jq expression (e.g., '.name', '.items[] | .id')
30+
--no-interactive Disable all interactive features (auto-prompting, explorer auto-launch, TUI forms)
31+
--no-keyring Never read or write the OS keychain; store secrets in the config file instead (env: MODAPI_NO_KEYRING)
32+
-o, --output-format string Specify the output format. Options: pretty, json, yaml, table, toon. (default "pretty")
33+
--raw-output Write --jq string results as raw text instead of JSON strings (like jq -r); non-string results stay JSON
34+
--secret-key string HTTP Bearer
35+
--server string Select a server by index (for indexed servers) or name (for named servers)
36+
--server-url string Override the default server URL
37+
--timeout string HTTP request timeout (e.g., 30s, 5m, 100ms)
38+
--usage Print the CLI Usage schema in KDL format
39+
```
40+
41+
### SEE ALSO
42+
43+
* [modapi](modapi.md) - Moderation API: Moderate text, images, video and audio in real time, manage authors, review queues and actions, and receive webhooks
44+
* [modapi analytics authors](modapi_analytics_authors.md) - Get the most flagged authors
45+
* [modapi analytics automation](modapi_analytics_automation.md) - Get the automation breakdown
46+
* [modapi analytics channels](modapi_analytics_channels.md) - Get analytics per channel
47+
* [modapi analytics policies](modapi_analytics_policies.md) - Get the most flagged policies
48+
* [modapi analytics summary](modapi_analytics_summary.md) - Get the analytics summary
49+
* [modapi analytics volumes](modapi_analytics_volumes.md) - Get volumes over time
50+
51+
Exit codes: 0 ok · 1 runtime · 2 usage · 3 authentication/authorization

‎docs/modapi_analytics_authors.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
## modapi analytics authors
2+
3+
Get the most flagged authors
4+
5+
### Synopsis
6+
7+
Get the authors with the most flagged content in a time window, largest first.
8+
9+
```
10+
modapi analytics authors [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
modapi analytics authors
17+
```
18+
19+
### Options
20+
21+
```
22+
-c, --channel string string value
23+
-h, --help help for authors
24+
-l, --limit int integer value (default 6)
25+
-p, --project-id string The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
26+
-r, --range string The time window. '24h' is the last 24 hours, in hourly buckets. '7d', '30d' and '90d' are whole UTC days that end with today, in daily buckets. (options: 24h, 7d, 30d, 90d) (default "30d")
27+
```
28+
29+
### Options inherited from parent commands
30+
31+
```
32+
--agent-mode Enable structured errors and default TOON output for AI coding agents. Automatically enabled when a known agent environment is detected (CLAUDECODE, CURSOR_AGENT, etc.). Use --agent-mode=false to disable.
33+
--color string Control colored output: auto (color when output is a TTY), always, or never. Respects NO_COLOR and FORCE_COLOR env vars. (default "auto")
34+
-d, --debug Log request and response diagnostics to stderr
35+
--dry-run Preview API requests without sending them (no network, no OS keychain). Human preview on stderr; with -o json or --jq, one JSON object per request on stdout. Local mutation commands (auth login, auth logout and configure) make no request: they skip prompts and writes and report a no-op (stderr, or one JSON object on stdout in the machine form)
36+
-H, --header stringArray Set a custom HTTP request header (format: "Key: Value"). Can be specified multiple times.
37+
--include-headers Include HTTP response headers in the output
38+
--interactive Prompt for missing inputs and open guided configure/auth forms (forms fall back to line prompts on stdin off-TTY) (default true)
39+
-q, --jq string Filter and transform output using a jq expression (e.g., '.name', '.items[] | .id')
40+
--no-interactive Disable all interactive features (auto-prompting, explorer auto-launch, TUI forms)
41+
--no-keyring Never read or write the OS keychain; store secrets in the config file instead (env: MODAPI_NO_KEYRING)
42+
-o, --output-format string Specify the output format. Options: pretty, json, yaml, table, toon. (default "pretty")
43+
--raw-output Write --jq string results as raw text instead of JSON strings (like jq -r); non-string results stay JSON
44+
--secret-key string HTTP Bearer
45+
--server string Select a server by index (for indexed servers) or name (for named servers)
46+
--server-url string Override the default server URL
47+
--timeout string HTTP request timeout (e.g., 30s, 5m, 100ms)
48+
--usage Print the CLI Usage schema in KDL format
49+
```
50+
51+
### SEE ALSO
52+
53+
* [modapi analytics](modapi_analytics.md) - Operations for analytics
54+
55+
### Machine interface
56+
57+
* `modapi analytics authors --usage` — this command's flags, defaults and env vars as machine-readable KDL
58+
* `modapi analytics authors --dry-run` — preview the request without OS-keychain access or a network call (human preview on stderr)
59+
* `--dry-run --output-format json` (or a caller-explicit `--jq`) writes one preview object per request as NDJSON on stdout; jq is not applied to previews
60+
* `--output-format json` or `--jq <expr>` for machine-readable live output; in agent mode errors are a JSON envelope on stderr
61+
62+
Exit codes: 0 ok · 1 runtime · 2 usage · 3 authentication/authorization
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
## modapi analytics automation
2+
3+
Get the automation breakdown
4+
5+
### Synopsis
6+
7+
Get how flagged content was handled in a time window: settled by rules or the casebook, or sent to human review, and what the reviewers decided.
8+
9+
```
10+
modapi analytics automation [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
modapi analytics automation
17+
```
18+
19+
### Options
20+
21+
```
22+
-c, --channel string string value
23+
-h, --help help for automation
24+
-p, --project-id string The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
25+
-r, --range string The time window. '24h' is the last 24 hours, in hourly buckets. '7d', '30d' and '90d' are whole UTC days that end with today, in daily buckets. (options: 24h, 7d, 30d, 90d) (default "30d")
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
--agent-mode Enable structured errors and default TOON output for AI coding agents. Automatically enabled when a known agent environment is detected (CLAUDECODE, CURSOR_AGENT, etc.). Use --agent-mode=false to disable.
32+
--color string Control colored output: auto (color when output is a TTY), always, or never. Respects NO_COLOR and FORCE_COLOR env vars. (default "auto")
33+
-d, --debug Log request and response diagnostics to stderr
34+
--dry-run Preview API requests without sending them (no network, no OS keychain). Human preview on stderr; with -o json or --jq, one JSON object per request on stdout. Local mutation commands (auth login, auth logout and configure) make no request: they skip prompts and writes and report a no-op (stderr, or one JSON object on stdout in the machine form)
35+
-H, --header stringArray Set a custom HTTP request header (format: "Key: Value"). Can be specified multiple times.
36+
--include-headers Include HTTP response headers in the output
37+
--interactive Prompt for missing inputs and open guided configure/auth forms (forms fall back to line prompts on stdin off-TTY) (default true)
38+
-q, --jq string Filter and transform output using a jq expression (e.g., '.name', '.items[] | .id')
39+
--no-interactive Disable all interactive features (auto-prompting, explorer auto-launch, TUI forms)
40+
--no-keyring Never read or write the OS keychain; store secrets in the config file instead (env: MODAPI_NO_KEYRING)
41+
-o, --output-format string Specify the output format. Options: pretty, json, yaml, table, toon. (default "pretty")
42+
--raw-output Write --jq string results as raw text instead of JSON strings (like jq -r); non-string results stay JSON
43+
--secret-key string HTTP Bearer
44+
--server string Select a server by index (for indexed servers) or name (for named servers)
45+
--server-url string Override the default server URL
46+
--timeout string HTTP request timeout (e.g., 30s, 5m, 100ms)
47+
--usage Print the CLI Usage schema in KDL format
48+
```
49+
50+
### SEE ALSO
51+
52+
* [modapi analytics](modapi_analytics.md) - Operations for analytics
53+
54+
### Machine interface
55+
56+
* `modapi analytics automation --usage` — this command's flags, defaults and env vars as machine-readable KDL
57+
* `modapi analytics automation --dry-run` — preview the request without OS-keychain access or a network call (human preview on stderr)
58+
* `--dry-run --output-format json` (or a caller-explicit `--jq`) writes one preview object per request as NDJSON on stdout; jq is not applied to previews
59+
* `--output-format json` or `--jq <expr>` for machine-readable live output; in agent mode errors are a JSON envelope on stderr
60+
61+
Exit codes: 0 ok · 1 runtime · 2 usage · 3 authentication/authorization

‎docs/modapi_analytics_channels.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
## modapi analytics channels
2+
3+
Get analytics per channel
4+
5+
### Synopsis
6+
7+
Get requests, flags and flag rate for each channel of the project in a time window.
8+
9+
```
10+
modapi analytics channels [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
modapi analytics channels
17+
```
18+
19+
### Options
20+
21+
```
22+
-h, --help help for channels
23+
-p, --project-id string The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
24+
-r, --range string The time window. '24h' is the last 24 hours, in hourly buckets. '7d', '30d' and '90d' are whole UTC days that end with today, in daily buckets. (options: 24h, 7d, 30d, 90d) (default "30d")
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
--agent-mode Enable structured errors and default TOON output for AI coding agents. Automatically enabled when a known agent environment is detected (CLAUDECODE, CURSOR_AGENT, etc.). Use --agent-mode=false to disable.
31+
--color string Control colored output: auto (color when output is a TTY), always, or never. Respects NO_COLOR and FORCE_COLOR env vars. (default "auto")
32+
-d, --debug Log request and response diagnostics to stderr
33+
--dry-run Preview API requests without sending them (no network, no OS keychain). Human preview on stderr; with -o json or --jq, one JSON object per request on stdout. Local mutation commands (auth login, auth logout and configure) make no request: they skip prompts and writes and report a no-op (stderr, or one JSON object on stdout in the machine form)
34+
-H, --header stringArray Set a custom HTTP request header (format: "Key: Value"). Can be specified multiple times.
35+
--include-headers Include HTTP response headers in the output
36+
--interactive Prompt for missing inputs and open guided configure/auth forms (forms fall back to line prompts on stdin off-TTY) (default true)
37+
-q, --jq string Filter and transform output using a jq expression (e.g., '.name', '.items[] | .id')
38+
--no-interactive Disable all interactive features (auto-prompting, explorer auto-launch, TUI forms)
39+
--no-keyring Never read or write the OS keychain; store secrets in the config file instead (env: MODAPI_NO_KEYRING)
40+
-o, --output-format string Specify the output format. Options: pretty, json, yaml, table, toon. (default "pretty")
41+
--raw-output Write --jq string results as raw text instead of JSON strings (like jq -r); non-string results stay JSON
42+
--secret-key string HTTP Bearer
43+
--server string Select a server by index (for indexed servers) or name (for named servers)
44+
--server-url string Override the default server URL
45+
--timeout string HTTP request timeout (e.g., 30s, 5m, 100ms)
46+
--usage Print the CLI Usage schema in KDL format
47+
```
48+
49+
### SEE ALSO
50+
51+
* [modapi analytics](modapi_analytics.md) - Operations for analytics
52+
53+
### Machine interface
54+
55+
* `modapi analytics channels --usage` — this command's flags, defaults and env vars as machine-readable KDL
56+
* `modapi analytics channels --dry-run` — preview the request without OS-keychain access or a network call (human preview on stderr)
57+
* `--dry-run --output-format json` (or a caller-explicit `--jq`) writes one preview object per request as NDJSON on stdout; jq is not applied to previews
58+
* `--output-format json` or `--jq <expr>` for machine-readable live output; in agent mode errors are a JSON envelope on stderr
59+
60+
Exit codes: 0 ok · 1 runtime · 2 usage · 3 authentication/authorization

‎docs/modapi_analytics_policies.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
## modapi analytics policies
2+
3+
Get the most flagged policies
4+
5+
### Synopsis
6+
7+
Get the policy labels that flagged the most content in a time window, largest first, with the count in the window before.
8+
9+
```
10+
modapi analytics policies [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
modapi analytics policies
17+
```
18+
19+
### Options
20+
21+
```
22+
-c, --channel string string value
23+
-h, --help help for policies
24+
-l, --limit int integer value (default 8)
25+
-p, --project-id string The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
26+
-r, --range string The time window. '24h' is the last 24 hours, in hourly buckets. '7d', '30d' and '90d' are whole UTC days that end with today, in daily buckets. (options: 24h, 7d, 30d, 90d) (default "30d")
27+
```
28+
29+
### Options inherited from parent commands
30+
31+
```
32+
--agent-mode Enable structured errors and default TOON output for AI coding agents. Automatically enabled when a known agent environment is detected (CLAUDECODE, CURSOR_AGENT, etc.). Use --agent-mode=false to disable.
33+
--color string Control colored output: auto (color when output is a TTY), always, or never. Respects NO_COLOR and FORCE_COLOR env vars. (default "auto")
34+
-d, --debug Log request and response diagnostics to stderr
35+
--dry-run Preview API requests without sending them (no network, no OS keychain). Human preview on stderr; with -o json or --jq, one JSON object per request on stdout. Local mutation commands (auth login, auth logout and configure) make no request: they skip prompts and writes and report a no-op (stderr, or one JSON object on stdout in the machine form)
36+
-H, --header stringArray Set a custom HTTP request header (format: "Key: Value"). Can be specified multiple times.
37+
--include-headers Include HTTP response headers in the output
38+
--interactive Prompt for missing inputs and open guided configure/auth forms (forms fall back to line prompts on stdin off-TTY) (default true)
39+
-q, --jq string Filter and transform output using a jq expression (e.g., '.name', '.items[] | .id')
40+
--no-interactive Disable all interactive features (auto-prompting, explorer auto-launch, TUI forms)
41+
--no-keyring Never read or write the OS keychain; store secrets in the config file instead (env: MODAPI_NO_KEYRING)
42+
-o, --output-format string Specify the output format. Options: pretty, json, yaml, table, toon. (default "pretty")
43+
--raw-output Write --jq string results as raw text instead of JSON strings (like jq -r); non-string results stay JSON
44+
--secret-key string HTTP Bearer
45+
--server string Select a server by index (for indexed servers) or name (for named servers)
46+
--server-url string Override the default server URL
47+
--timeout string HTTP request timeout (e.g., 30s, 5m, 100ms)
48+
--usage Print the CLI Usage schema in KDL format
49+
```
50+
51+
### SEE ALSO
52+
53+
* [modapi analytics](modapi_analytics.md) - Operations for analytics
54+
55+
### Machine interface
56+
57+
* `modapi analytics policies --usage` — this command's flags, defaults and env vars as machine-readable KDL
58+
* `modapi analytics policies --dry-run` — preview the request without OS-keychain access or a network call (human preview on stderr)
59+
* `--dry-run --output-format json` (or a caller-explicit `--jq`) writes one preview object per request as NDJSON on stdout; jq is not applied to previews
60+
* `--output-format json` or `--jq <expr>` for machine-readable live output; in agent mode errors are a JSON envelope on stderr
61+
62+
Exit codes: 0 ok · 1 runtime · 2 usage · 3 authentication/authorization

0 commit comments

Comments
 (0)