docs_

Configuration

Full reference for every key supported in config.toml, followed by three complete example configurations. See the README for how to create and locate the config file.

[settings] — Application settings (optional)

[settings.layout] — Input area heights and result preview pane (optional)

Controls the height (in terminal rows) of each input area on the connected screen, and the size/position of the preview pane in the result viewer. Omitted keys fall back to their defaults.

[settings.layout]
sql_input_height = 10
shell_input_height = 5
prompt_input_height = 5
result_preview_width = 30
result_preview_position = "right"

Note: these keys must be placed under the [settings.layout] section, not directly under [settings] — misplaced keys are silently ignored. An invalid result_preview_position value (anything other than "up", "down", "left", or "right") causes a configuration error at startup.

[[connections]] — Connection entry (one or more required)

bastion field behavior

[connections.bastion] — Per-connection bastion settings

[connections.mysql] — MySQL settings

[connections.mysql.pool] — Connection pool settings (optional)

[default_bastion] — Shared bastion settings (optional)

Applied to all connections with bastion = true. Fields are the same as [connections.bastion].

[default_mysql_pool] — Shared pool settings (optional)

Applied to all connections that do not specify their own pool settings. Per-connection settings take precedence. Fields are the same as [connections.mysql.pool].

Example 1: Direct connection (local development)

[[connections]]
name = "local-dev"

[connections.mysql]
host = "localhost"
port = 3306
database = "your_database"
user = "root"
password = "your_password"
ssl_mode = "disabled"  # acceptable for local development

Example 2: Shared bastion (production environments)

Use [default_bastion] when multiple connections share the same bastion server.

[default_bastion]
host = "bastion.example.com"
port = 22
user = "your_ssh_user"
# Omit key_path to use your SSH agent (e.g., 1Password SSH agent)

[default_mysql_pool]
max_connections = 20
idle_timeout = 600

[[connections]]
name = "production"
bastion = true  # uses [default_bastion]

[connections.mysql]
host = "mysql.internal.example.com"
port = 3306
database = "production_db"
user = "app_user"
password = "secure_password"
timeout = 60
ssl_mode = "required"

[[connections]]
name = "staging"
bastion = true  # uses [default_bastion]
readonly = true

[connections.mysql]
host = "mysql-staging.internal.example.com"
port = 3306
database = "staging_db"
user = "app_user"
password = "staging_password"
ssl_mode = "preferred"

Example 3: Per-connection bastion

Use [connections.bastion] when each connection has a different bastion server.

[[connections]]
name = "region-a"

[connections.bastion]
host = "bastion-a.example.com"
port = 22
user = "your_ssh_user"
key_path = "~/.ssh/id_rsa"

[connections.mysql]
host = "mysql-a.internal.example.com"
port = 3306
database = "db_a"
user = "app_user"
password = "password_a"
ssl_mode = "required"

[[connections]]
name = "region-b"

[connections.bastion]
host = "bastion-b.example.com"
port = 2222
user = "your_ssh_user"
key_path = "~/.ssh/id_ed25519"

[connections.mysql]
host = "mysql-b.internal.example.com"
port = 3306
database = "db_b"
user = "app_user"
password = "password_b"
ssl_mode = "required"

See config.example.toml in the repository for a complete annotated example.

Key Bindings

Connection Selection

Connection selection is handled by skim (Rust-native fzf). Standard fzf key bindings apply.

SQL Input

SQL input is handled directly by sqsh. Press Tab to switch focus between SQL Input and Shell Input.

Execution and Completion

Editing

Navigation and Other

Shell Input

Shell Input allows running shell commands without leaving sqsh. Press Tab to switch focus from SQL Input.

When connected via a bastion server, commands execute on the bastion host. For direct connections, commands execute locally.

Result Viewer

Result display is handled by skim (Rust-native fzf). Standard fzf key bindings apply.