Quickstart

This quickstart uses the kiwi fabric CLI. The same steps can be done in the Web UI or through the REST API.

1. Point the CLI at your server#

kiwi fabric connect --url https://localhost:5000

connect saves the server URL (and an optional API key) for later commands. Replace the URL with the address of your instance.

2. Create the first admin user#

A new instance has no users. The one-time bootstrap command creates the first admin and prints an initial API key:

kiwi fabric auth-setup --user admin --password "<choose-a-strong-password>"

Then sign in so later commands are authenticated:

kiwi fabric login --user admin --password "<your-password>"

3. Register a data source#

kiwi fabric source-add --name sales-pg --type Rdbms --subtype Postgres \
  --conn "<connection-string>" --username "<user>" --password "<password>"

--type is one of Rdbms, Rest, Soap, NoSql, File, Cloud or VectorDb. Credentials are encrypted at rest. See Register data sources.

Check what the source exposes:

kiwi fabric source-schema --name sales-pg

4. Expose tables as capabilities#

A capability is a named table (or stored procedure) that the engine can address in SQL. The Web UI import wizard is the easiest way to register them; from the CLI use kiwi fabric cap-add --file <definition.json>. See Capabilities.

5. Run a query#

kiwi fabric query --sql "SELECT * FROM customers WHERE city = @city" --param city=London --verbose

--verbose adds a per-source breakdown showing rows fetched and which predicates were pushed down. With two or more registered sources you can join across them in the same statement.

Next steps#

• Run federated queries
• Run a distributed transaction
• Connect BI and analytics tools
• Secure data access