Global feature flags
Experimental runtime features can be overridden for a single process with top-level flags:config.toml. Use coral features enable <FEATURE> or
coral features disable <FEATURE> to persist a preference.
coral sql
Run one SQL query and exit.
Options
| Option | Type | Default | Description |
|---|---|---|---|
--format | table | json | table | Output format |
null values when the row value is null.
coral source
Manage configured sources, either the bundled ones, or your custom source specs.
coral source discover
List the bundled sources available in your current Coral build.
installed or still available.
coral source list
List sources currently installed.
keychain or
file (plaintext).
coral source info <NAME>
Show metadata for a source: whether it is installed, its origin, version, description, and inputs. Works for bundled sources and imported sources installed via coral source add --file.
-v/--verbose for more detailed output.
coral source add <NAME>
Add a bundled source or update its credentials.
By default, Coral reads each declared input from an environment variable of the same name. If a required input is missing, the command exits with an error listing the missing keys.
--interactive to be prompted for variables and secrets instead. If a
missing secret declares credential methods, Coral shows those choices in the
source spec’s authored order. source_config methods use the normal source
input path and prompt for the secret value here; OAuth methods open or print an
authorization URL or device verification URL, wait for provider completion, and
store the resulting access token without printing token material. If the
provider returns refresh metadata, Coral keeps it internally so short-lived
OAuth access tokens can be refreshed without re-running coral source add.
If the browser runs somewhere that cannot reach Coral’s loopback listener, such
as a host browser authorizing a Coral process in a VM or SSH session, paste the
final localhost redirect URL into the terminal prompt and Coral submits it to
the local callback listener.
Environment variables still win, so a secret value already present in the
environment bypasses the retrieval choice.
test_queries declared in the source spec to validate the connection. Any post-install validation issue is reported as a warning here so the source remains installed and re-runnable.
Sources use OS credential storage by default when Coral can write, read, and
delete a keychain probe item. If the keychain is unavailable in auto mode,
Coral stores the source secrets in plaintext file storage and shows
file (plaintext) in source output. Sources with no stored secret material show
none.
coral source add --file <PATH>
Add a custom source spec from a YAML file. Input values come from environment variables by default; add --interactive to be prompted.
coral source lint <FILE>
Validate a source spec YAML file without installing it. Checks YAML syntax, JSON schema conformance, and semantic rules such as duplicate columns or references to unknown filters.
coral source test <NAME>
Validate that an installed source can initialize, expose tables, and run any optional top-level test_queries declared in its source spec. The command errors when one or more declared query tests fail.
coral source remove <NAME>
Remove an installed source.
coral onboard
Run the guided source setup flow.
source_config method still uses the normal environment-variable or prompt
path.
coral features
Coral ships with experimental runtime features that can be enabled on demand.
These features are defined in config.toml.
coral features list
List all runtime features recognized by the current Coral binary, including their configured and effective status.
coral features enable <FEATURE>
Persistently enables an experimental runtime feature. The default for each
feature is listed in Configuration.
coral features disable <FEATURE>
Persistently disables an experimental runtime feature.
coral ui
Open the local Coral UI in your browser.
http://127.0.0.1:1457 by default, which only accepts connections from your machine. The command keeps running until you press Ctrl-C.
The host is fixed to 127.0.0.1. Use --port to bind a different loopback port:
--no-open to start the same loopback server without launching a browser:
coral mcp-stdio
Expose the local Coral runtime as an MCP stdio server.
| Type | Name | Description |
|---|---|---|
| Tool | sql | Execute read-only SQL against the Coral database |
| Tool | list_catalog | List database tables and table functions |
| Tool | search_catalog | Search database catalog metadata by regex |
| Tool | describe_table | Show compact database table metadata |
| Tool | list_columns | List columns for one database table |
| Resource | coral://guide | Database workflow guide for agents |
| Resource | coral://tables | Database table summaries |
coral completion <SHELL>
Generate a shell completion script and write it to standard output. Supported shells are bash, zsh, fish, elvish, and powershell.