Using dirsql from the CLI

Online: https://thekevinscott.github.io/dirsql/cli/

dirsql ships a command-line interface that starts an HTTP server exposing the same indexing, querying, and watching functionality as the SDK — no host language required. Run it in any directory to query your files over HTTP: with no config it serves a default files table, and a config file defines custom tables.

Everything you need to run dirsql as a CLI lives in this section:

• Installation — get the dirsql binary.
• Running the Server — subcommands and flags.
• Generating a Config (init) — scaffold a .dirsql.toml.
• Configuration File — the .dirsql.toml format and the .py / .js native-language alternative. Custom tables are defined through a config file; without one, the server runs in zero-config mode.
• HTTP API — the POST /query and GET /events endpoints, status codes, and event streaming.

Installation

npm

npx dirsql

PyPI

uvx dirsql

Cargo

# Installs the binary only (the `cli` feature is non-default)
cargo install dirsql --features cli
dirsql

Node version

Requires Node ≥ 20.11.

For Rust library consumers

The cli feature is opt-in. See the Rust library README for instructions on how to include.

Quick start

From any directory containing your files (no config needed):

dirsql

$ Running at localhost:7117

Then query it over HTTP:

curl -s http://localhost:7117/query \
  -H 'content-type: application/json' \
  -d '{"sql":"SELECT COUNT(*) AS n FROM files"}' \
  | jq

See Running the Server for flags and HTTP API for the full endpoint reference.