# DuckLocal

> DuckLocal is a free, open-source (Apache-2.0) desktop app for querying the data files on your own computer with DuckDB SQL. Drop in CSV, TSV, Parquet, JSON or Excel files, a folder, a glob pattern, a `.duckdb` database or an S3 bucket, and query them in place: no server to run, nothing uploaded, no account, no telemetry. It runs on macOS 12+ (Apple silicon), 64-bit Windows 10+ and Linux x86_64.

Key facts:

- Each opened file becomes a view named after the file (`sales.csv` → `sales`); files are read where they are, never copied or changed.
- The app is a native desktop program written in Rust with DuckDB embedded; queries run locally.
- The `ducklocal` command runs one SQL statement headlessly and prints JSON (or Markdown), so AI agents and scripts can query local files. An official agent skill teaches agents to read the schema before querying.
- Dashboards are plain-text `.dash` files of `query` and `plot` blocks, validated with `ducklocal check`; dashboard queries are read-only.
- Results can be charted in the app and exported to CSV or Parquet.
- Download: https://github.com/JetSquirrel/DuckLocal/releases/latest
- Source code: https://github.com/JetSquirrel/DuckLocal

Every documentation page is also served as Markdown: add `.md` to its address (for example https://ducklocal.app/docs/cli.md). All English pages in one file: https://ducklocal.app/docs/llms-full.txt; Chinese: https://ducklocal.app/docs/zh/llms-full.txt

## Docs

- [Getting started](https://ducklocal.app/docs/getting-started.md): install on Mac, Windows or Linux, add the `ducklocal` command, open a file and run a first query
- [Your first 10 minutes](https://ducklocal.app/docs/tutorial.md): a tutorial with a sample CSV — query, chart, export, and the same question from the CLI
- [Data sources](https://ducklocal.app/docs/data-sources.md): CSV, TSV, Parquet, JSON, Excel, folders, glob patterns, DuckDB databases; view names and limits
- [S3 and httpfs](https://ducklocal.app/docs/s3.md): query Amazon S3 and S3-compatible storage
- [SQL editor](https://ducklocal.app/docs/sql-editor.md): query tabs, formatting, EXPLAIN, autocompletion, shortcuts
- [Schema and history](https://ducklocal.app/docs/schema-and-history.md): the schema sidebar and query history
- [Results and charts](https://ducklocal.app/docs/results-and-charts.md): the results grid, export to CSV or Parquet, charts, row limits
- [CLI and agent skill](https://ducklocal.app/docs/cli.md): headless SQL with a JSON contract, profiling, file conversion, and the official AI agent skill
- [Dashboards (.dash)](https://ducklocal.app/docs/dashboards.md): declare queries and plots in a text file, validate and edit them
- [Analysis apps](https://ducklocal.app/docs/analysis-app.md): JavaScript views over your data, exportable as one HTML page
- [Troubleshooting](https://ducklocal.app/docs/troubleshooting.md): symptoms, causes and fixes

## Optional

- [Settings and app data](https://ducklocal.app/docs/settings-and-data.md): what DuckLocal stores, interface size, theme, language, reset
- [Development](https://ducklocal.app/docs/development.md): build from source with Rust, run the tests, cut a release
- [中文文档](https://ducklocal.app/docs/zh/): the same documentation in Simplified Chinese