Skip to content
QQL Documentation

CLI Reference

Global Flags

Section titled “Global Flags”
FlagDescription
--quietSuppress decorative output
--jsonOutput structured JSON

qql-go connect

Section titled “qql-go connect”

Configure the connection to a Qdrant instance.

Usage 
qql-go connect --url <qdrant-url> [flags]

Connection Flags

Section titled “Connection Flags”
--url string
required
--secret string
optional
--inference-mode enum: cloud, local, external
optional
--embedding-endpoint string
optional
--embedding-key string
optional
--embedding-model string
optional
--embedding-dimension integer (auto)
optional
FlagDefaultDescription
--url—Qdrant gRPC URL (port 6334)
--secret—Qdrant API key
--inference-modecloudcloud, local, or external
--embedding-endpoint—OpenAI-compatible /v1/embeddings URL
--embedding-key—Bearer token for embedding provider
--embedding-model—Model name
--embedding-dimensionautoVector dimension (auto-probed if reachable)

Examples:

Cloud connection 
qql-go connect --url https://<cluster>.qdrant.io --secret <api-key>
Local connection 
qql-go connect --url http://localhost:6334 --inference-mode local
--embedding-endpoint http://127.0.0.1:1234/v1/embeddings
--embedding-model text-embedding-all-minilm-l6-v2-embedding

qql-go exec

Section titled “qql-go exec”

Execute a single QQL statement.

Usage 
qql-go exec "<statement>" qql-go exec --quiet --json "<statement>"
Examples 
qql-go exec "QUERY 'search' FROM docs LIMIT 5 USING HYBRID" qql-go exec "CREATE COLLECTION docs HYBRID" qql-go exec "SHOW COLLECTIONS" qql-go exec --quiet --json "QUERY 'search' FROM docs LIMIT 5"

qql-go explain

Section titled “qql-go explain”

Parse a QQL statement and return the execution plan without running it.

Usage 
qql-go explain "<statement>" qql-go explain --json "<statement>"
Examples 
qql-go explain "QUERY 'search' FROM docs LIMIT 5 USING HYBRID RERANK" qql-go explain --json "QUERY 'search' FROM docs LIMIT 5"

qql-go execute

Section titled “qql-go execute”

Execute a .qql script file.

Usage 
qql-go execute <script.qql> qql-go execute --stop-on-error <script.qql> qql-go execute --quiet --json <script.qql>
FlagDescription
--stop-on-errorStop on first statement failure
--quietSuppress decorative output
--jsonOutput structured JSON array

qql-go dump

Section titled “qql-go dump”

Export a collection as a runnable .qql script.

Usage 
qql-go dump <collection> <output.qql> qql-go dump --batch-size <n> <collection> <output.qql> qql-go dump --quiet --json <collection> <output.qql>
FlagDefaultDescription
--batch-size100Number of points per INSERT statement

qql-go convert

Section titled “qql-go convert”

Translate Qdrant REST API JSON to QQL statements.

Usage 
qql-go convert <payload.json> cat payload.json | qql-go convert qql-go convert --validate <payload.json> qql-go convert --json <payload.json> qql-go convert --quiet <payload.json>
FlagDescription
--validateRun output through EXPLAIN to verify it parses
--jsonOutput structured JSON
--quietOutput only QQL statements, no decoration

qql-go serve

Section titled “qql-go serve”

Start the Connect RPC gateway.

Usage 
qql-go serve [flags]

Core Flags

Section titled “Core Flags”
FlagDefaultDescription
--listen:50051Address to listen on
--qdrant-urlhttp://localhost:6334Qdrant gRPC endpoint
--api-key—Qdrant API key

Embedding Flags

Section titled “Embedding Flags”
FlagDefaultDescription
--inference-modelocalcloud, local, or external
--embedding-endpoint—Embedding server URL
--embedding-modelsentence-transformers/all-minilm-l6-v2Model name
--embedding-dimension384Vector dimension

Auth Flags

Section titled “Auth Flags”
FlagDefaultDescription
--jwks-url—JWKS endpoint URL
--jwt-issuer—Expected iss claim
--jwt-audience—Expected aud claim
--jwks-cache-ttl10mKey cache TTL
--role-claimroleJWT claim path for roles
--tenant-claimtenant_idJWT claim path for tenant

Policy Flags

Section titled “Policy Flags”
FlagDefaultDescription
--policy-file—Path to YAML policy file
--policy-reloadfalseHot-reload policy on file change

Rate Limit Flags

Section titled “Rate Limit Flags”
FlagDefaultDescription
--rate-limit0Max requests/sec per user (0 = unlimited)
--rate-limit-capacity20Max burst size per user

Other Flags

Section titled “Other Flags”
FlagDefaultDescription
--templates—Path to YAML query templates file
--auditfalseEnable structured audit logging
--audit-file—Audit log output file (default: stderr)

qql-go doctor

Section titled “qql-go doctor”

Report connection and configuration status.

Usage 
qql-go doctor qql-go doctor --quiet --json

qql-go repl

Section titled “qql-go repl”

Start the interactive REPL.

Start REPL 
qql-go repl

qql-go disconnect

Section titled “qql-go disconnect”

Remove the stored connection config.

Usage 
qql-go disconnect

qql-go version

Section titled “qql-go version”

Print the CLI version.

Version 
qql-go version
qql-go X.Y.ZSection titled “qql-go X.Y.Z”