Client
gonemaster-client is the command-line client for gonemaster-server. Use it
when you want to submit jobs, run batches, inspect stored results, or query
tagged analysis data through the admin API.
For direct local tests that do not use the server, use ../cli/ .
Connection
The default server is:
gonemaster-client --server http://localhost:8080/api/v1 jobs listSet --server to the admin API base URL. The report command reads the
public analysis API, which the client derives from that same base.
Global Options
| Flag | Type | Details |
|---|---|---|
--server URL | string | Base admin API URL. Default http://localhost:8080/api/v1. |
--timeout DURATION | string | HTTP timeout. Default 30s. |
--format FORMAT | string | pretty, json, jsonl, or json-stream. |
--output PATH | string | Write output to a file. |
--locale LOCALE | string | Locale for translated result messages. Default en. |
--no-color | bool | Disable ANSI colors in pretty output. |
--header NAME:VALUE | repeatable | Add an HTTP header. |
--version | bool | Print version information and exit. |
Subcommand flags may be placed before or after positional arguments. -h is
the only single-dash option; it is an alias for --help and works on a
command group and on a subcommand alike.
Output Formats
Use --format pretty for terminal output and --format json for scripts.
Use jsonl or json-stream when a command emits multiple JSON records.
Most commands also accept --output PATH.
Exit codes:
0: success2: usage or runtime error, including HTTP errors130: interrupted by signal
Command Groups
jobs: submit, watch, cancel, purge, and fetch job results.batches: inspect and manage batch groups.queue: pause, resume, reorder, or remove queued jobs.domains: inspect and tag domain records.tags: manage named domain collections.runs: inspect completed historical runs.entries: query stored log entries.cohorts: list the analysis cohorts and their snapshots, and manage their snapshot schedules.report: compare two cohort snapshots and classify every change.
Guides
- Jobs: jobs.md
- Batches: batches.md
- Domains, tags, runs, and entries: domains-tags-runs-entries.md
- Cohorts and schedules: cohorts.md
- Cohort report: report.md
- Examples: examples.md
The concise Unix man-page form is kept at ../man/gonemaster-client.1.md .