CLI reference

federiq [--config PATH] [-v] <subcommand>

Every subcommand accepts --help for detail. A condensed reference:

SubcommandPurpose
initScaffold a new federiq.yaml
sources listList declared sources
sources addAdd a source
sources removeRemove a source
sources testVerify one or all sources are reachable
sources describeShow source detail and generated ATTACH SQL
schema listList tables in a source
schema describeShow column types for a table
queryExecute SQL (see flags below)
shellInteractive REPL
serveHTTP server with auth + TLS + metrics
config showPrint resolved catalog YAML
config validateLint catalog sources
policy listList policies
policy showShow one policy
policy validateCross-check policies against sources
policy checkStatic violation scan for a SQL query
cache statusCache statistics
cache clearEmpty the cache
doctorEnvironment diagnostics
completions <shell>Emit shell completion scripts

federiq query flags

FlagMeaning
-f, --file PATHRead SQL from a file
-o, --output PATHWrite results to a file
--format FMTtable (default), csv, json, ndjson, parquet
--explainPrint DuckDB plan
--explain-analyzePlan plus per-operator timing
--timingPrint total and per-source timing
--cache MODEoff / memory / disk
--cache-dir PATHDisk cache location
--enforce-policy BOOLDefault true when catalog has policies