Harlequin
The SQL IDE for Your Terminal.
  • Get Started
  • Docs
  • Blog
  • About
  • Sponsor
  • GitHub icon
    tconbeer/harlequin
    GitHub stars6,401 GitHub forks176

Python 3.15 is not supported by all Harlequin dependencies. For the best experience, install Harlequin using Python 3.14 with uv tool install --python 3.14 harlequin. See this issue for updates.

  • Getting Started
    • Installing Harlequin
    • Running Harlequin
    • Using Harlequin
    • Using hsql
    • Getting Help
  • The hsql CLI
    • hsql Overview
    • Exit Codes and Streams
    • Exploring the Catalog
    • Formats and Layouts
    • Config Modes
    • Running Safely
    • Warm Sessions
    • Differences from psql
    • Reference: hsql CLI
    • The hsql Agent Skill
  • Agent Docs
  • Database Adapters
    • Adapters Overview
    • Adapter: DuckDB
      • DuckDB Basic Usage
      • Initialization Scripts
      • Loading Extensions
      • Transaction Handling
      • MotherDuck
    • Adapter: SQLite
      • SQLite Basic Usage
      • Initialization Scripts
      • Loading Extensions
      • Transaction Handling
    • Adapter: Postgres
      • Postgres Basic Usage
      • Multiple Databases
      • Transaction Handling
    • Adapter: Redshift
      • Redshift Basic Usage
      • Redshift Authentication
      • Redshift Data Catalog
    • Adapter: Snowflake
      • Snowflake Basic Usage
      • Snowflake Authentication
    • Adapter: MySQL/MariaDB
    • Adapter: ODBC
    • Adapter: BigQuery
      • BQ Installation and Configuration
      • Auth and Permissions
    • Adapter: Trino
    • Adapter: Databricks
      • Installation and Basic Usage
      • Initialization Scripts
    • Adapter: ADBC
    • Adapter: chDB
    • Adapter: RisingWave
    • Adapter: Wherobots
    • Adapter: Cassandra
    • Adapter: NebulaGraph
    • Adapter: Exasol
    • Adapter: H2
  • Configuring Harlequin
    • Config Overview
    • Creating Config Files
    • Discovering Config Files
    • Selecting a Profile
  • SSH Tunnels
    • SSH Tunnels Overview
    • SSH Configuration
    • SSH Security
    • Troubleshooting SSH
  • Viewing Files
    • Files Overview
    • Local Files
    • Remote Objects (S3)
  • Choosing a Theme
  • Customizing Key Bindings
    • About Key Bindings
    • Creating a Keymap
    • Selecting Keymaps
  • Exporting Data
  • Managing Transactions
  • Reference: Default Bindings
  • Troubleshooting
    • Common Problems
    • Key Bindings
    • Copying and Pasting
    • Appearance
    • Locale
    • Windows Timezone Database
    • DuckDB Version Mismatch
    • Terminal Recommendations
  • Contributing to Harlequin
    • Ways to Contribute
    • Creating an Adapter

Terminal Recommendations

View as Markdown

If you are using the default Mac Terminal or Windows Command Prompt, you may want to switch to a more modern terminal. The following terminals are free and come highly recommended:

  • Windows (native or WSL2): Windows Terminal
  • Mac: iTerm2
  • Linux: Gnome, Alacritty

← Previous

DuckDB Version Mismatch

Next →

Ways to Contribute

  • Docs
  • Blog
  • About
  • GitHub

Shandy Data LLC ©2026. Icons by Icons8.