Polygres CLI

The Polygres CLI manages Polygres projects from the terminal. It authenticates with the control plane and supports project setup, imports, migrations, and retrieval configuration. It does not expose database passwords.

Install

pip install polygres-cli

For an isolated global installation:

pipx install polygres-cli

The command remains polygres:

polygres login
polygres whoami
polygres projects list
polygres projects use <project-id-or-exact-name>
polygres env
polygres ready

polygres login opens the Polygres dashboard for approval and prints a URL for headless terminals. Credentials are stored at ~/.config/polygres/config.json with owner-only permissions on POSIX systems. Run polygres logout to revoke the refresh token and remove local credentials.

Common project operations:

polygres import csv ./documents.csv --table documents --wait
polygres migrations apply --file ./001_create_documents.sql
polygres graph discover --json > graph.json
polygres graph config apply --file graph.json
polygres vector configs list
polygres text configs list

Run polygres --help for the full command reference. Exit codes distinguish validation (2), authentication (3), permission (4), not found (5), conflict (6), rate limiting (7), remote availability (8), and missing local tools such as psql (9).

Relationship to the Python SDK

The CLI is distributed separately from the Python SDK. Install polygres-sdk when your application needs Runtime API retrieval methods, and install polygres-cli when you need the terminal command. The CLI has its own control-plane client and does not require the SDK.

Users of the former combined polygres package should install polygres-cli and polygres-sdk separately.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

polygres_cli-0.1.2.tar.gz (41.8 kB view details)

Uploaded Jul 14, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

polygres_cli-0.1.2-py3-none-any.whl (31.1 kB view details)

Uploaded Jul 14, 2026 Python 3

File details

Details for the file polygres_cli-0.1.2.tar.gz.

File metadata

Download URL: polygres_cli-0.1.2.tar.gz
Upload date: Jul 14, 2026
Size: 41.8 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for polygres_cli-0.1.2.tar.gz
Algorithm	Hash digest
SHA256	`e7de84ca0c60701a41113320a5ccb32ad8c0e0a5fe796312c73de4dab31b00bf`
MD5	`4a5409af31b720a45cd0aec36d4dfb54`
BLAKE2b-256	`54ac6308bbe5779bb371f33b82959fbca239b742c62b68733d7db2f3049dd9e6`

See more details on using hashes here.

Provenance

The following attestation bundles were made for polygres_cli-0.1.2.tar.gz:

Publisher: publish-python-cli.yml on Evokoa/polygres-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: polygres_cli-0.1.2.tar.gz
- Subject digest: e7de84ca0c60701a41113320a5ccb32ad8c0e0a5fe796312c73de4dab31b00bf
- Sigstore transparency entry: 2170821359
- Sigstore integration time: Jul 14, 2026
Source repository:
- Permalink: Evokoa/polygres-cli@5bf8dc877cf9d019f9b167bfd17b360c22d1c624
- Branch / Tag: refs/tags/python-cli-v0.1.2
- Owner: https://github.com/Evokoa
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish-python-cli.yml@5bf8dc877cf9d019f9b167bfd17b360c22d1c624
- Trigger Event: push