Awesome
<a name="readme-top"></a>
About The Project
This project is heavily inspired by Lazygit, which I think is the best TUI client for Git.
I wanted to have a tool like that, but for SQL. I didn't find one that fits my needs, so I created one myself.
I live in the terminal, so if you are like me, this tool can become handy for you too.
This is my first Open Source project, also, this is my first Go project. I am not a brilliant programmer. I am just a typical JavaScript developer that wanted to learn a new language, I also wanted a TUI SQL Client, so white and bottled.
This project is in ALPHA stage, please feel free to complain about my spaghetti code.
I use Lazysql daily in my full-time job as a full-stack javascript developer in its current (buggy xD) state. So, the plan is to improve and fix my little boy as a side-project in my free time.
Built With
Features
- Cross-platform (macOS, Windows, Linux)
- Vim Keybindings
- Can manage multiple connections (Backspace)
- Tabs
- SQL Editor (CTRL + e)
Getting Started
Installation
Homebrew
brew tap jorgerojas26/lazysql
brew install lazysql
Install with go package manager
go install github.com/jorgerojas26/lazysql@latest
Binary Releases
For Windows, macOS or Linux, you can download a binary release here
Third party (maintained by the community)
Arch Linux users can install it from the AUR with:
paru -S lazysql
or
yay -S lazysql
or install it manual with:
git clone https://aur.archlinux.org/lazysql.git
cd lazysql
makepkg -si
Usage
$ lazysql
Support
- MySQL
- PostgreSQL
- SQLite
- MSSQL
- MongoDB
Support for multiple RDBMS is a work in progress.
Keybindings
Global
| Key | Action |
|---|---|
| q | Quit |
| CTRL + e | Open SQL editor |
| Backspace | Return to connection selection |
| ? | Show keybindings popup |
Table
| Key | Action |
|---|---|
| c | Edit table cell |
| d | Delete row |
| o | Add row |
| / | Focus the filter input or SQL editor |
| CTRL + s | Commit changes |
| > | Next page |
| < | Previous page |
| K | Sort ASC |
| J | Sort DESC |
| H | Focus tree panel |
| [ | Focus previous tab |
| ] | Focus next tab |
| X | Close current tab |
| R | Refresh the current table |
Tree
| Key | Action |
|---|---|
| L | Focus table panel |
| G | Focus last database tree node |
| g | Focus first database tree node |
SQL Editor
| Key | Action |
|---|---|
| CTRL + R | Run the SQL statement |
| CTRL + Space | Open external editor (Linux only) |
Specific editor for lazysql can be set by $SQL_EDITOR.
Specific terminal for opening editor can be set by $SQL_TERMINAL
Example connection URLs
postgres://user:pass@localhost/dbname
pg://user:pass@localhost/dbname?sslmode=disable
mysql://user:pass@localhost/dbname
mysql:/var/run/mysqld/mysqld.sock
sqlserver://user:pass@remote-host.com/dbname
mssql://user:pass@remote-host.com/instance/dbname
ms://user:pass@remote-host.com:port/instance/dbname?keepAlive=10
oracle://user:pass@somehost.com/sid
sap://user:pass@localhost/dbname
file:myfile.sqlite3?loc=auto
/path/to/sqlite/file/test.db
odbc+postgres://user:pass@localhost:port/dbname?option1=
Roadmap
- Support for NoSQL databases
- Columns and indexes creation through TUI
- Table tree input filter
- Custom keybindings
- Show keybindings on a modal
- Rewrite row
create,updateanddeletelogic
See the open issues for a full list of proposed features (and known issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>Clipboard support
We use atotto/clipboard to copy to clipboard.
Platforms:
- OSX
- Windows 7 (probably work on other Windows)
- Linux, Unix (requires 'xclip' or 'xsel' command to be installed)
Contributing
Contributions, issues, and pull requests are welcome!
<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- LICENSE -->License
Distributed under the MIT License. See LICENSE.txt for more information.
Contact
Jorge Rojas - LinkedIn - jorgeluisrojasb@gmail.com
<p align="right">(<a href="#readme-top">back to top</a>)</p>