Coral Bricks CLI — connect data sources and run syncs locally into managed storage.
Project description
coralbricks
Pip-installable CLI for Coral Bricks AI — connect 600+ data sources and run syncs on your own machine, straight into managed storage.
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.
Project details
Release history Release notifications | RSS feed
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 coralbricks-0.1.4.tar.gz.
File metadata
- Download URL: coralbricks-0.1.4.tar.gz
- Upload date:
- Size: 35.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8ebdda01dda089a10f3e1c96c1f9fd48456a9894569b25011f6ef4d51ef82195
|
|
| MD5 |
bc9fbd414aa738f5142a728ea30b0a9d
|
|
| BLAKE2b-256 |
9b2a2bd2750158830469e9e7fb8a5b69cd95380823eba3d63a69cd3b87e6b82a
|
File details
Details for the file coralbricks-0.1.4-py3-none-any.whl.
File metadata
- Download URL: coralbricks-0.1.4-py3-none-any.whl
- Upload date:
- Size: 35.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
25f59620956adfb76637daeb3b7545bfa277832e4bd078999e684c358facffe3
|
|
| MD5 |
243e13963e31b8c3d5d13e4f575c92db
|
|
| BLAKE2b-256 |
e75f0f38d21ef4c4bf742b4b7540ca8cd0cd35b64cb91dc7d0d0cdde87d8879f
|