The SynDB CLI (syndb) provides command-line access to all platform features.
# With GUI
pipx install syndb-cli[gui]
# Without GUI
pipx install syndb-cli
| Option | Environment Variable | Description |
|---|
--server-url | SYNDB_SERVER_URL | API base URL |
--flight-url | SYNDB_FLIGHT_URL | Arrow Flight endpoint |
--flight-port | SYNDB_FLIGHT_PORT | Arrow Flight port |
| Command | Description |
|---|
syndb user register | Create a new account |
syndb user login | Authenticate and store token |
syndb user logout | Revoke token |
| Command | Description |
|---|
syndb query list | List saved queries |
syndb query save | Save a new query |
syndb query show {id} | Show query details |
syndb query update {id} | Update a saved query |
syndb query delete {id} | Delete a saved query |
syndb query run {id} | Execute a saved query |
syndb query status {id} | Check execution status |
| Command | Description |
|---|
syndb dataset new | Register a new dataset |
syndb dataset prepare | Validate and convert to Parquet |
syndb dataset validate | Schema validation only |
syndb dataset upload | Upload data via Arrow Flight |
syndb dataset download | Download dataset via Arrow Flight |
syndb dataset mesh-upload | Upload 3D mesh files (.glb) |
Each dataset supports download, validate, and import subcommands:
syndb etl <dataset> download
syndb etl <dataset> validate
syndb etl <dataset> import [--tables <table1,table2>]
| Dataset | Key | Description |
|---|
| FlyWire | flywire | Whole-brain Drosophila connectome |
| Hemibrain | hemibrain | Janelia FlyEM v1.2.1 |
| MANC | manc | Male Adult Nerve Cord |
| MICrONS | microns | Mouse visual cortex |
| H01 | h01 | Human cortical tissue |
| BANC | banc | Brain And Nerve Cord |
| FANC | fanc | Female Adult Nerve Cord |
| Fish1 | fish1 | Zebrafish brain |
| Optic Lobe | optic-lobe | Drosophila optic lobe |
| Male CNS | male-cns | Male central nervous system |
| C. elegans Hermaphrodite | c-elegans-herm | Complete hermaphrodite |
| C. elegans Male | c-elegans-male | Complete male |
| C. elegans Developmental | c-elegans-dev | Developmental stages |
| Platynereis | platynereis | Marine annelid |
| L1 Larval | l1-larval | Drosophila L1 larval brain |
| Spine Morphometry (Kasthuri) | spine-kasthuri | Dendritic spine morphometry |
| Spine Morphometry (Ofer) | spine-ofer | Dendritic spine morphometry |
| Spine Morphometry (MICrONS) | spine-microns | Dendritic spine morphometry |
| Allen Cell Types | allen-cell-types | Allen Institute reference |
| NeuroMorpho | neuromorpho | NeuroMorpho.org archive |
| Command | Description |
|---|
syndb federation init | Initialize federation config and register with hub |
syndb federation status | Show federation configuration |
syndb federation sync-schema | Sync ClickHouse schema from hub |
syndb federation test | Test connectivity (mDNS + hub + ClickHouse) |
syndb federation clusters | List all federated clusters |
syndb federation logout | Remove federation config |
See Node Setup for detailed usage.
syndb graph-precompute --dataset-id {uuid}
Pre-computes graph metrics and stores results in ClickHouse materialized tables.
| Command | Description |
|---|
syndb k8s jobs | List ETL jobs |
syndb k8s status | View job status |
syndb k8s cleanup | Clean up completed/failed jobs |
Performance testing suite for API and federation queries.
syndb completions bash > ~/.local/share/bash-completion/completions/syndb
syndb completions zsh > ~/.zfunc/_syndb
syndb completions fish > ~/.config/fish/completions/syndb.fish