cli

module
v1.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 23, 2026 License: Apache-2.0

README

synthient/cli

Synthient's official CLI tool. Currently in beta.

Install

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

Basic Commands

synthient auth

auth demo video

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:

  1. Provide your API key as an environment variable with the key being SYNTHIENT_API_KEY.
  2. Store it in a .env file in the current directory with the key SYNTHIENT_API_KEY.
synthient lookup

lookup demo video

[!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.127
synthient lookup 213.149.183.127 168.205.174.84
echo "213.149.183.127 168.205.174.84" | synthient lookup

Here 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 "-")

Feeds

Streaming (synthient stream)

stream demo video

[!NOTE] You need to be authenticated to run this command.

Stream feed events as newline-delimited JSON to stdout. The first argument selects the feed:

synthient stream anonymizer
synthient stream torrent
synthient stream proxy
Downloading (synthient download)

download demo video

[!NOTE] 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.parquet

To download a specific date's snapshot instead of the latest:

synthient download anonymizers.parquet --date 2026-05-14

Here 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 downloading

Configuration

Configuration 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"

Directories

Path Synopsis
internal
cli

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL