Skip to content

Commit 0d0ebc0

Browse files
committed
Update README and dependencies
- Document Turso database support - Update uv.lock with new dependencies
1 parent a7c4e41 commit 0d0ebc0

2 files changed

Lines changed: 22 additions & 1 deletion

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,27 @@ You can also receive autocompletion on columns by typing the table name and hitt
121121

122122
Connections and settings are stored in `~/.sqlit/`.
123123

124+
## FAQ
125+
126+
### How are sensitive credentials stored?
127+
128+
Credentials are stored in plain text in a protected directory (`~/.sqlit/`) with restricted file permissions (700/600).
129+
130+
### How does sqlit compare to Harlequin, Lazysql, etc.?
131+
132+
sqlit is inspired by [lazygit](https://github.com/jesseduffield/lazygit) - you can just jump in and there's no need for external documentation. The keybindings are shown at the bottom of the screen and the UI is designed to be intuitive without memorizing shortcuts.
133+
134+
Key differences:
135+
- **No need for external documentation** - Sqlit embrace the "lazy" approach in that a user should be able to jump in and use it right away intuitively. There should be no setup instructions. If python packages are required for certain adapters, sqlit will help you install them as you need them.
136+
- **No CLI config required** - Just run `sqlit` and pick a connection from the UI
137+
- **Lightweight** - While Lazysql or Marlequin offer more features, I experienced that for the vast majority of cases, all I needed is an simple and fast way to connect and run queries. Sqlit is centered about doing a limited amount of things really well.
138+
139+
## Inspiration
140+
141+
sqlit is built with [Textual](https://github.com/Textualize/textual) and inspired by:
142+
- [lazygit](https://github.com/jesseduffield/lazygit) - Simple TUI for git
143+
- [lazysql](https://github.com/jorgerojas26/lazysql) - Terminal-based SQL client with connection manager
144+
124145
## Contributing
125146

126147
See `CONTRIBUTING.md` for development setup, testing, CI, and CockroachDB quickstart steps.

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)