Synthient's official CLI tool. Currently in beta.
| System | Install Command |
|---|---|
| macOS | brew install synthient/tap/synthient or go install github.com/synthient/cli/cmd@latest |
| Linux | go install github.com/synthient/cli/cmd@latest |
| Windows | go install github.com/synthient/cli/cmd@latest |
Authenticate the CLI with your Synthient API key. This API key will then be stored in your system's keychain for secure storage. If you want to authenticate a different way there are two other options:
- Provide your API key as an environment variable with the key being
SYNTHIENT_API_KEY. - Store it in a
.envfile in the current directory with the keySYNTHIENT_API_KEY.
Note
You need to be authenticated to run this command.
Lookup a given IP address. Works with piped input and/or multiple IP address as seen here:
synthient lookup 213.149.183.127synthient lookup 213.149.183.127 168.205.174.84echo "213.149.183.127 168.205.174.84" | synthient lookupHere is a full look into all of the options for the lookup command:
Usage:
synthient lookup [flags]
Flags:
-f, --format string Output format [text|json|csv] (default "text")
-h, --help help for lookup
-o, --output string Where to write output: '-' for stdout, or a file path (e.g. 'lookup.json' or 'lookup.csv) (default "-")Note
You need to be authenticated to run this command.
Stream anonymizer feed events as newline-delimited JSON to stdout:
synthient streamNote
You need to be authenticated to run this command.
Download an anonymizer feed snapshot as a Parquet file. The filename argument must end in .parquet:
synthient download anonymizers.parquetTo download a specific date's snapshot instead of the latest:
synthient download anonymizers.parquet --date 2026-05-14Here is a full look into all of the options for the download command:
Usage:
synthient download [flags]
Flags:
-d, --date string Snapshot date to download (YYYY-MM-DD or 'latest') (default "latest")
-h, --help help for download
-s, --silent Do not output when downloadingConfiguration for the synthient CLI is located in ~/.config/synthient/config.toml. Right now the customizable fields are the hosts for API and feeds data:
[endpoints]
base_api = "https://customhost.com"
base_feeds = "https://otherhost.com"


