# sqrail

> sqrail is a small, read-only SQL-on-files CLI for coding agents.

Canonical documentation: https://sqrails.yhay81.com/docs/
Source and provenance: https://github.com/yhay81/sqrail
Releases: https://github.com/yhay81/sqrail/releases
License: MIT

## Install

Homebrew installs the executable:

```sh
brew install yhay81/tap/sqrail
```

GitHub CLI 2.90 or newer previews and installs the Agent Skill for the
current host:

```sh
gh skill preview yhay81/sqrail sqrail
gh skill install yhay81/sqrail sqrail --agent codex --scope user
```

Replace `codex` with the active host. Prebuilt archives for Linux, macOS, and
Windows: https://github.com/yhay81/sqrail/releases

Human-readable setup guide: https://sqrails.yhay81.com/docs/agents/
Agent-readable setup instructions: https://sqrails.yhay81.com/install-agent.md

## Agent rule

If names and types are unknown, run `sqrail schema FILE...` once.
Otherwise trust the stated schema, run one query, and stop after success.

## Interface

Use `sqrail --help`, or fetch:
https://sqrails.yhay81.com/help.txt

## Human-readable documentation

- Quick start: https://sqrails.yhay81.com/docs/
- Agent setup: https://sqrails.yhay81.com/docs/agents/
- CLI contract: https://sqrails.yhay81.com/docs/reference/contract/
- Agent integration: https://sqrails.yhay81.com/docs/reference/agents/
- Performance baselines: https://sqrails.yhay81.com/docs/reference/performance/
- Benchmark policy: https://sqrails.yhay81.com/docs/reference/benchmarks/
- Platform support: https://sqrails.yhay81.com/docs/reference/platforms/
- Security boundary: https://sqrails.yhay81.com/docs/security/
- Contributing: https://sqrails.yhay81.com/docs/contributing/

## Agent-readable sources

- CLI contract: https://github.com/yhay81/sqrail/blob/main/docs/CONTRACT.md
- Agent integration: https://github.com/yhay81/sqrail/blob/main/docs/AGENT_INTEGRATION.md
- Agent Skill: https://github.com/yhay81/sqrail/tree/main/skills/sqrail
- Security boundary: https://github.com/yhay81/sqrail/blob/main/SECURITY.md
- Benchmark policy: https://github.com/yhay81/sqrail/blob/main/docs/BENCHMARKS.md