harlequin 0.0.6

A Text User Interface for DuckDB

harlequin

A Terminal-based SQL IDE for DuckDB.

(A Harlequin is also a pretty duck.)

Installing Harlequin

Use pip or pipx:

pipx install harlequin

Tip:

You can run invoke directly with pipx run anywhere that pipx is installed. For example:

• pipx run harlequin --help
• pipx run harlequin ./my.duckdb

Using Harlequin

To open a DuckDB database file:

harlequin "path/to/duck.db"

To open an in-memory DuckDB session, run Harlequin with no arguments:

harlequin

When Harlequin is open, you can view the schema of your DuckDB database in the left sidebar.

To run a query, enter your code in the main textarea, then press Ctrl+Enter. You should see the data appear in the pane below.

You can press Tab or use your mouse to change the focus between the panes.

When the focus is on the data pane, you can use your arrow keys or mouse to select different cells.

Press Ctrl+c to quit and return to your shell.

Running Harlequin in a Container

Without a database file:

docker run ghcr.io/tconbeer/harlequin:latest

Mounting a database file ./foo.db into the container's working directory, /data:

docker run -v $(pwd)/foo.db:/data/bar.db ghcr.io/tconbeer/harlequin:latest harlequin bar.db