Command reference
Every command and flag in CLI 0.5.27. gosset <command> --help prints the same information in your terminal.
gosset --help
gosset --version # or: gosset version| Command | What it does | Page |
|---|---|---|
gosset drugs | Search drugs and therapeutic assets | drugs |
gosset trials | Search clinical trials | trials |
gosset companies | Search companies | companies |
gosset deals | Search licensing, M&A and financing deals | deals |
gosset news | Search news and press releases | news |
gosset abstracts | Search conference abstracts across meetings | abstracts |
gosset ptrs | Trial progression estimate (PTRS) for one NCT id | Predictions |
gosset timeline | Predicted primary-completion date for one NCT id | Predictions |
gosset schema | The published field list for each entity | schema |
gosset usage | How much of each dataset your account has used | Usage & limits |
gosset skills | Agent workflows bundled with the CLI | Teach your agent |
gosset auth | Sign in and store your API key. Aliases: login, get-key | Getting started |
gosset get-token | Print an OAuth token for MCP clients | Getting started |
gosset version | Print the CLI version |
The package also installs gosset-cli, an alias for gosset.
Flags on every entity command
drugs, trials, companies, deals, news and abstracts share these:
| Flag | Default | Meaning |
|---|---|---|
--limit N | 25 | Results per page. The server caps a page (usually 100) and warns when it does |
--offset N | 0 | Rows to skip |
--all | off | Fetch the whole set, paging for you, as one array. Refuses above 10,000 rows. Not with --offset |
--sort FIELD | per command | Sort on a published field; prefix - for descending. Write --sort=-phase, with = |
--fields a,b,c | all fields | Return only these fields (JSON and table) |
--table | off | Print a table instead of JSON |
--json | on | JSON output (the default; overrides --table) |
--include-ids | off | Add id fields such as target_ids and disease_class_ids, for joining records |
--where COND | none | Any other condition, see Filtering with --where. Repeatable |
--debug | off | Print the query object sent to the API, on stderr |
--api-key KEY | stored key | Use this key for this call |
--base-url URL | https://api.gosset.ai | Use another API endpoint |
Filters per entity command
gosset drugs [NAME]
| Flag | Meaning |
|---|---|
NAME | Drug name, brand or code, resolved to the drug |
--target | Target name or id, e.g. PD-1 |
--disease | Disease name or id, e.g. "atopic dermatitis" |
--modality | Modality name or id, e.g. mAb, ADC |
--company | Developer name or id |
--phase | Preclinical, 1, 2, 3, 4, Approved, Discontinued (comma list) |
--route | Route(s) of administration |
--action | agonist, antagonist, or an exact effect such as "Partial agonist" |
--combination | none, fixed_dose, mixture, co_administration (comma list) |
--include-combinations | Also return trial-arm regimens such as cisplatin + vinflunine, hidden by default |
--industry-only | Count only industry programs; needs --disease |
Default sort: most advanced first (-phase).
gosset trials [SEARCH]
| Flag | Meaning |
|---|---|
SEARCH | Free text: NCT id, acronym or title |
--drug, --disease, --target, --sponsor | Name or id |
--phase | 1, 2, 3, 4 (comma list) |
--status | Trial status(es), e.g. Active, Completed, Terminated |
--registry | ctg (default), eu_ctis, another registry code, or all |
--since, --until | Completion date range, YYYY-MM-DD |
--industry-only | Trials with an industry sponsor or collaborator |
--has-results | Trials with reported results |
Default sort: latest completion date first (-completion_date).
gosset companies [NAME]
| Flag | Meaning |
|---|---|
NAME | Company name, resolved to the company |
--disease, --modality | Name or id; matches the company's pipeline |
--country | Country name(s) |
--type | Company category, e.g. Biotech, "Big Pharma" |
--stage | Company stage, e.g. "Phase 3", Commercial |
--public | Listed companies only |
Default sort: latest funding round first.
gosset deals
| Flag | Meaning |
|---|---|
--drug, --target, --disease | Name or id |
--buyer, --seller | Company name or id |
--deal-type | Deal type(s), e.g. Licensing, "M&A", Fundraising |
--since, --until | Deal date range, YYYY-MM-DD |
--min-value | Minimum total deal value, USD |
Default sort: newest first. No positional argument.
gosset news [SEARCH]
| Flag | Meaning |
|---|---|
SEARCH | Free text over title and summary |
--drug, --disease, --company | Name or id |
--category | Category tag(s), e.g. Results, Approval, Conference |
--since, --until | Publication date range, YYYY-MM-DD |
Default sort: newest first.
gosset abstracts [SEARCH]
| Flag | Meaning |
|---|---|
SEARCH | Free text over the abstract |
--drug | Drug name or id; matches every meeting |
--disease, --target, --modality | Name or id (target and modality of the primary drug) |
--company | Developer of the primary drug |
--conference | Series (ASCO), list (ASCO,ESMO) or one edition ("ASCO 2025") |
--year | Edition year(s) |
--nct | Linked trial id(s) |
--phase | Furthest phase of the primary drug, not of the study |
--annotation-level | annotated or link_only |
--min-impact | Minimum impact score, 0 to 10 |
--since, --until | Presentation date range, YYYY-MM-DD |
Default sort: newest first.
Other commands
gosset ptrs NCT_ID
| Flag | Default | Meaning |
|---|---|---|
--model-version | v3 | v3, or v4-rc for the current V4 model (v4-rc.6 names the same release) |
--api-key, --base-url | As above |
gosset timeline NCT_ID
| Flag | Default | Meaning |
|---|---|---|
--as-of YYYY-MM-DD | today | Predict as if it were this date, for backtests |
--api-key, --base-url | As above |
gosset schema [ENTITY]
No entity: list the entities and their field counts. With one of drugs, trials, companies, deals, news, abstracts: list its fields with a description each. Takes --api-key and --base-url.
gosset usage
| Flag | Meaning |
|---|---|
--json | Print the full report as JSON |
--api-key, --base-url | As above |
gosset skills [NAME]
| Flag | Meaning |
|---|---|
NAME | A skill to print as Markdown. Today: competitive-landscape |
--json | The catalog, or the skill with its metadata, as JSON |
Works offline and without signing in.
gosset auth (login, get-key)
| Flag | Meaning |
|---|---|
| (none) | Sign in in the browser and store the key |
--manual | Sign in on a machine with no browser: prints a URL to open elsewhere |
--code CODE | Finish a --manual sign-in with the code the page shows |
--status | Show whether you are signed in, and where the key comes from |
--logout | Remove the stored key |
--print-export | Print export GOSSET_API_KEY=... instead of storing the key (CI) |
--quiet | Print only the key |
--base-url | Sign in against another API endpoint |
gosset get-token
| Flag | Meaning |
|---|---|
--quiet | Print only the token |
--base-url | Another API endpoint |
Prints an OAuth token for MCP clients. The CLI, the SDK and the REST API use the key from gosset auth instead.
Environment variables
| Variable | Purpose | Default |
|---|---|---|
GOSSET_API_KEY | API key | the stored key |
GOSSET_OAUTH_TOKEN | Used when GOSSET_API_KEY is not set | |
GOSSET_API_URL | API base URL | https://api.gosset.ai |
GOSSET_CONFIG_DIR | Folder that holds the stored key | $XDG_CONFIG_HOME/gosset, else ~/.config/gosset |
GOSSET_FORCE_MANUAL_AUTH | 1 makes gosset auth use the paste-the-code flow |
Exit codes
| Code | Meaning |
|---|---|
0 | Success, including an empty result |
1 | No API key, an API error, or a malformed flag value. The error is JSON on stderr |
2 | A name you passed matched nothing; --all refused a set above 10,000 rows or was combined with --offset; or the command line itself is invalid (unknown flag, bad choice) |
130 | Interrupted (Ctrl-C) |