Synth CLI
synthkb-cli is the small, secure remote client for deterministic,
revision-bound evidence from a Synth Project. It does not install the Synth
server, generate answers, invoke an LLM, ingest sources, or mutate Projects.
Requires Python 3.11–3.14 and supports macOS, Linux, and Windows.
Install
pipx install synthkb-cli
# or: uv tool install synthkb-cli
synth --version
Connect and read evidence
Create a read-only knowledge:read API key in Settings → API Keys, then:
synth login https://synth.example.com
synth projects
synth use docs
synth search "authentication"
synth page PAGE_PATH --snapshot SNAPSHOT_ID
synth status
synth logout
Login verifies the server, key, compatibility, and optional Project before it saves anything. The OS keychain is preferred; a private file backend is available for headless environments.
For CI, keep secrets out of process arguments:
synth login https://synth.example.com \
--api-key-file /run/secrets/synth-api-key \
--project prj_docs \
--credential-store file \
--non-interactive \
--json
Use synth doctor --json for redacted diagnostics. See the
complete CLI reference and
automation guide.
Additional HTTP headers
For a server behind an access gateway, pass generic headers before the command:
synth \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET" \
login https://synth.example.com
To apply the same headers to every command in a shell or CI job, use a JSON
object in SYNTH_HTTP_HEADERS:
export SYNTH_HTTP_HEADERS='{"X-Gateway-Client":"client","X-Gateway-Secret":"secret"}'
synth login https://synth.example.com
synth status
Additional headers are not saved in the Synth profile or printed by debug
output. Authorization and other headers owned by the CLI cannot be overridden.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file synthkb_cli-0.5.2.tar.gz.
File metadata
- Download URL: synthkb_cli-0.5.2.tar.gz
- Upload date:
- Size: 23.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1127672b7c4eb0d9fa4136db363bff3aa2d7e65f240ee06c1fef7351f3b24771
|
|
| MD5 |
f4eae0c620ec9f8f80b7830343714ab8
|
|
| BLAKE2b-256 |
9715d288e55dfd38702bd11e1862ebb0a927b3731af2393a19178b27e4ceeff7
|
Provenance
The following attestation bundles were made for synthkb_cli-0.5.2.tar.gz:
Publisher:
synth-cli-release.yml on synthkb/synth
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
synthkb_cli-0.5.2.tar.gz -
Subject digest:
1127672b7c4eb0d9fa4136db363bff3aa2d7e65f240ee06c1fef7351f3b24771 - Sigstore transparency entry: 2365466832
- Sigstore integration time:
-
Permalink:
synthkb/synth@5fc265862df4945cddad91abd4afda21592633f9 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/synthkb
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
synth-cli-release.yml@5fc265862df4945cddad91abd4afda21592633f9 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file synthkb_cli-0.5.2-py3-none-any.whl.
File metadata
- Download URL: synthkb_cli-0.5.2-py3-none-any.whl
- Upload date:
- Size: 17.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5505574690d77e7cb7e54660cf5bbb9ef5a2210ed051bc83a64d70e7255f1ac5
|
|
| MD5 |
c69275d971fef8c2c3b60a6a3d67ae41
|
|
| BLAKE2b-256 |
bf5bf67dad2c7b9639c1f677dd2dba049fb7d39554cf128907f7053d574f3aef
|
Provenance
The following attestation bundles were made for synthkb_cli-0.5.2-py3-none-any.whl:
Publisher:
synth-cli-release.yml on synthkb/synth
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
synthkb_cli-0.5.2-py3-none-any.whl -
Subject digest:
5505574690d77e7cb7e54660cf5bbb9ef5a2210ed051bc83a64d70e7255f1ac5 - Sigstore transparency entry: 2365466843
- Sigstore integration time:
-
Permalink:
synthkb/synth@5fc265862df4945cddad91abd4afda21592633f9 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/synthkb
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
synth-cli-release.yml@5fc265862df4945cddad91abd4afda21592633f9 -
Trigger Event:
workflow_dispatch
-
Statement type:
