Skip to content

Commit 593dfb2

Browse files
committed
Add SSH tunnel support to README
1 parent 7c99fa0 commit 593dfb2

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ A simple terminal UI for SQL Server, PostgreSQL, MySQL, SQLite, and more—built
1515
## Features
1616

1717
- **Multi-database support**: SQL Server, PostgreSQL, MySQL, SQLite, MariaDB, Oracle, DuckDB, and CockroachDB
18+
- **SSH tunnel support**: Connect to remote databases through SSH with password or key-based authentication
1819
- **Query history**: Automatically saves queries per connection, searchable and sortable
1920
- Fast and intuitive keyboard only control
2021
- Context based help (no need to memorize tons of hot-keys)
@@ -87,6 +88,10 @@ sqlit connection create --name "MyMySQL" --db-type mysql --server "localhost" --
8788
sqlit connection create --name "MyCockroach" --db-type cockroachdb --server "localhost" --port "26257" --database "defaultdb" --username "root"
8889
sqlit connection create --name "MyLocalDB" --db-type sqlite --file-path "/path/to/database.db"
8990

91+
# Connect via SSH tunnel
92+
sqlit connection create --name "RemoteDB" --db-type postgresql --server "db-host" --username "dbuser" --password "dbpass" \
93+
--ssh-enabled --ssh-host "ssh.example.com" --ssh-username "sshuser" --ssh-auth-type password --ssh-password "sshpass"
94+
9095
# Manage connections
9196
sqlit connection list
9297
sqlit connection delete "MyConnection"

0 commit comments

Comments
 (0)