Skip to main content

coralbricks

Pip-installable CLI for Coral Bricks AI — connect 600+ data sources and run syncs on your own machine, straight into managed storage.

License Python

pip install coralbricks

30-second quickstart

coralbricks login             # paste an API key from coralbricks.ai/settings/api-keys
coralbricks sources           # list available connectors
coralbricks connect notion    # OAuth in your browser, or prompt for an API key
coralbricks sync notion       # pull Airbyte image, run locally, upload to managed S3
coralbricks connections       # list what you've connected
coralbricks runs notion       # recent sync history for this source

Commands

Command What it does
coralbricks login Prompts for an API key (or --api-key ak_…), validates against the backend, stores in ~/.coralbricks/config.json (mode 0600)
coralbricks logout Removes the stored API key
coralbricks whoami Re-validates the stored key and prints the logged-in user
coralbricks sources Lists connectors available on your account (name, auth type)
coralbricks connect <source> Connects a data source — OAuth in the browser (loopback pattern) or interactive API-key prompts. One connection per source; re-running refreshes credentials in place.
coralbricks disconnect <source> Removes a previously-configured connection for a source. Prompts for confirmation (use -y to skip).
coralbricks sync <source> Pulls the Airbyte source Docker image, runs it on your machine, and uploads records (gzipped JSONL, raw Airbyte Protocol shape) to our managed S3. Credentials are STS session creds scoped to exactly this run's prefix for 1 hour. Requires Docker Desktop / Engine running.
coralbricks connections Lists the connections you've already set up
coralbricks runs <source> Shows recent sync runs for a source (status, records, bytes, timestamp).

Configuration

Env var Purpose Default
CORALBRICKS_API_KEY Overrides the stored key (useful in CI) —
CORALBRICKS_SERVER_URL Override the backend URL https://backend.coralbricks.ai
CORALBRICKS_ALLOWED_BUCKETS Comma-separated S3 buckets the CLI will accept as a sync destination. Defaults to the prod managed bucket; set this only if you're testing against a non-prod backend. coralbricks-connectors

Development

cd cli
pip install -e '.[dev]'
pytest

Tests use responses to mock the backend — no live services required.

License

Apache 2.0 © Coral Bricks AI.

Metadata

Release files for coralbricks 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for coralbricks 0.1.4
File Size Uploaded
coralbricks-0.1.4.tar.gz 35.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for coralbricks 0.1.4
File Interpreter ABI Platform
coralbricks-0.1.4-py3-none-any.whl Python 3 none any Details

Total release size: 71.2 kB

Release files / coralbricks-0.1.4.tar.gz

Download URL coralbricks-0.1.4.tar.gz
Size 35.7 kB
Tags Source
SHA-256 checksum
How to use checksums
8ebdda01dda089a10f3e1c96c1f9fd48456a9894569b25011f6ef4d51ef82195
BLAKE2b-256 checksum
How to use checksums
9b2a2bd2750158830469e9e7fb8a5b69cd95380823eba3d63a69cd3b87e6b82a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.12

Release files / coralbricks-0.1.4-py3-none-any.whl

Download URL coralbricks-0.1.4-py3-none-any.whl
Size 35.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
25f59620956adfb76637daeb3b7545bfa277832e4bd078999e684c358facffe3
BLAKE2b-256 checksum
How to use checksums
e75f0f38d21ef4c4bf742b4b7540ca8cd0cd35b64cb91dc7d0d0cdde87d8879f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.12

Release history Release notifications | RSS feed

This release

0.1.4 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page