EddytorDocs & API

CLI command index

Every eddytor command at a glance - verbs, resources, and where to learn each.

The eddytor CLI uses a verb-first grammar: eddytor <verb> <resource> [args] [--json]. Table-scoped commands take positional <catalog> <schema> <table> (domain commands a fourth <column>). Run eddytor <verb> --help for exact flags.

Auth & config

CommandDoes
eddytor login / logoutOAuth 2.1 device-code sign-in / clear creds
eddytor doctorDiagnose connectivity, auth, and Flight SQL
eddytor config set-api-url <url>Set the REST API URL
eddytor config set-flight-url <url>Set the Flight SQL URL (for query)
eddytor config set-key <edd_live_…>Set an API key
eddytor config showPrint resolved config

Read & query

CommandDoes
eddytor get tablesList discovered tables
eddytor get history <c> <s> <t>Table version history
eddytor get storage · get objects <cfg>Storage configs / objects
eddytor get domain · get domain-values · get domain-usageDomain inspection
eddytor get api-keys · get audit-log · get org · get users · get sso · get providersOrg resources
eddytor describe table <c> <s> <t>Schema, columns, constraints
eddytor query "<SQL>" --limit NFlight SQL query
eddytor profile table <c> <s> <t>Per-column stats
eddytor validate table <c> <s> <t>Constraint violations

Create & modify

CommandDoes
eddytor create table <name> --location <url> --schema-file <json>Create a table
eddytor create column <c> <s> <t> --schema-file <json>Add columns
eddytor create constraint …Add a CHECK constraint
eddytor create folder <cfg> <path>Create a folder
eddytor create demo-table <cfg>Seed demo_products
eddytor create storage s3|azure|gcs …Register storage
eddytor create api-key <name> --scopes …API key
eddytor set column <c> <s> <t> --column <col> --is-unique|--is-primary-key|--is-nullable <bool>Column settings
eddytor set domain <c> <s> <t> <col> …Set a domain
eddytor set sso · set provider-app · set fieldSSO / provider app / field metadata

Data (DML, from a file)

CommandDoes
eddytor insert table <c> <s> <t> --file <f>Insert rows
eddytor merge table <c> <s> <t> --file <f>Upsert / merge
eddytor delete rows <c> <s> <t> --file <f>Delete by key
eddytor upload <cfg> … / download <cfg> …Objects
eddytor infer-schema --file <f>Infer a schema

Versioning & lifecycle

CommandDoes
eddytor diff table <c> <s> <t> --from <N> --to <N>Diff versions
eddytor rollback table <c> <s> <t> --version <N>Rollback (destructive)
eddytor restore table <c> <s> <t> --timestamp <ISO>Restore (destructive)
eddytor rename table <c> <s> <t> --destination-path <rel>Rename
eddytor move table <c> <s> <t> --dest-config-id <id> --dest-path <rel>Move
eddytor optimize table <c> <s> <t>Compact files
eddytor vacuum table <c> <s> <t> [--retention-hours N] [--dry-run]Vacuum
eddytor delete table <c> <s> <t>Drop a table (irreversible)

Other

CommandDoes
eddytor link|unlink provider azure|googleLink cloud accounts
eddytor magic-dust · explain-rowsAI analysis
eddytor installInstall resources (skills)

Good to know

--json (global) gives machine-readable output for scripting - a no-op on side-effecting commands. --insecure skips TLS verification (local/self-signed dev only). See eddytor CLI.

On this page