Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tconbeer/harlequin
The SQL IDE for Your Terminal.
https://github.com/tconbeer/harlequin
Last synced: 13 days ago
JSON representation
The SQL IDE for Your Terminal.
- Host: GitHub
- URL: https://github.com/tconbeer/harlequin
- Owner: tconbeer
- License: mit
- Created: 2023-05-02T15:44:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-21T04:44:14.000Z (6 months ago)
- Last Synced: 2023-12-21T15:20:35.918Z (6 months ago)
- Language: Python
- Homepage: https://harlequin.sh
- Size: 16.5 MB
- Stars: 560
- Watchers: 8
- Forks: 15
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-tuis - harlequin
- awesome-stars - tconbeer/harlequin - The SQL IDE for Your Terminal. (Python)
- my-awesome-stars - tconbeer/harlequin - The SQL IDE for Your Terminal. (Python)
- awesome-stars - tconbeer/harlequin - `★2784` The SQL IDE for Your Terminal. (Python)
- my-awesome - tconbeer/harlequin - The SQL IDE for Your Terminal. (Python)
- cli-apps - harlequin - The SQL IDE for Your Terminal. (<a name="data-management-tabular"></a>Data management - Tabular data)
- awesome-stars - tconbeer/harlequin - The SQL IDE for Your Terminal. (Python)
- my-awesome-stars - tconbeer/harlequin - The SQL IDE for Your Terminal. (Python)
- awesome-cli-apps - harlequin - The SQL IDE for Your Terminal. (<a name="data-management-tabular"></a>Data management - Tabular data)
- awesome-stars - tconbeer/harlequin - The SQL IDE for Your Terminal. (Python)
README
# Harlequin
[](https://pypi.org/project/harlequin/)
The SQL IDE for Your Terminal.
## Installing Harlequin
After installing Python 3.8 or above, install Harlequin using `pip` or `pipx` with:
```bash
pipx install harlequin
```
## Using Harlequin with DuckDB
From any shell, to open one or more DuckDB database files:
```bash
harlequin "path/to/duck.db" "another_duck.db"
```
To open an in-memory DuckDB session, run Harlequin with no arguments:
```bash
harlequin
```
If you want to control the version of DuckDB that Harlequin uses, see the [Troubleshooting](https://harlequin.sh/docs/troubleshooting/duckdb-version-mismatch) page.
## Using Harlequin with SQLite and Other Adapters
Harlequin also ships with a SQLite3 adapter. You can open one or more SQLite database files with:
```bash
harlequin -a sqlite "path/to/sqlite.db" "another_sqlite.db"
```
Like DuckDB, you can also open an in-memory database by omitting the paths:
```bash
harlequin -a sqlite
```
Other adapters can be installed using `pip install ` or `pipx inject harlequin `, depending on how you installed Harlequin. For a list of known adapters provided either by the Harlequin maintainers or the broader community, see the [adapters](https://harlequin.sh/docs/adapters) page in the docs.
## Getting Help
To view all command-line options for Harlequin and all installed adapters, after installation, simply type:
```bash
harlequin --help
```
To view a list of all key bindings (keyboard shortcuts) within the app, press F1. You can also view this list outside the app [in the docs](https://harlequin.sh/docs/bindings).
COLOR, KEY BINDING, OR COPY-PASTE PROBLEMS? See [Troubleshooting](https://harlequin.sh/docs/troubleshooting/index) in the docs.
## More info at [harlequin.sh](https://harlequin.sh)
Visit [harlequin.sh](https://harlequin.sh) for an overview of features and full documentation.
## Sponsoring Harlequin
Please consider [sponsoring Harlequin's author](https://github.com/sponsors/tconbeer), so he can continue to dedicate time to Harlequin.
## Contributing
Thanks for your interest in Harlequin! Harlequin is primarily maintained by [Ted Conbeer](https://github.com/tconbeer), but he welcomes all contributions!
Please see [`CONTRIBUTING.md`](./CONTRIBUTING.md) for more information.