squix

Category: Tools & Productivity | Uploader: eduardofuncao | Downloads: 0 | Version: v1.0（Latest）

Squix is a CLI tool for managing and executing SQL queries across multiple

Changelog: Source: GitHub https://github.com/eduardofuncao/squix

Directory Structure

Current level: tree/main/

📁 .github/
- 📁 workflows/
  - 📄 ci.yml 390 B
  - 📄 release.yml 5.6 KB
- 📄 FUNDING.yml 935 B
📁 cmd/
- 📁 squix/
  - 📄 add.go 2.0 KB
  - 📄 app.go 3.2 KB
  - 📄 completion.go 3.3 KB
  - 📄 config.go 750 B
  - 📄 disconnect.go 644 B
  - 📄 edit.go 7.2 KB
  - 📄 explain.go 14.1 KB
  - 📄 explore.go 3.5 KB
  - 📄 help.go 21.3 KB
  - 📄 history.go 198 B
  - 📄 info.go 1.4 KB
  - 📄 init.go 3.5 KB
  - 📄 list.go 4.5 KB
  - 📄 main.go 384 B
  - 📄 remove.go 2.2 KB
  - 📄 run.go 10.8 KB
  - 📄 shell.go 6.8 KB
  - 📄 status.go 1.6 KB
  - 📄 switch.go 606 B
  - 📄 tables.go 7.0 KB
  - 📄 utils.go 252 B
📁 docs/
- 📄 commands.md 2.3 KB
- 📄 completion.md 1.4 KB
- 📄 configuration.md 1.7 KB
- 📄 databases.md 1.7 KB
- 📄 features.md 4.3 KB
- 📄 keybindings.md 1.6 KB
📁 internal/
- 📁 completion/
  - 📄 bash.go 438 B
  - 📄 fish.go 161 B
  - 📄 zsh.go 407 B
- 📁 config/
  - 📄 config.go 3.1 KB
  - 📄 connectionYAML.go 1.0 KB
  - 📄 query_saver.go 1.5 KB
- 📁 db/
  - 📄 base_connection.go 3.9 KB
  - 📄 clickhouse_connection.go 7.3 KB
  - 📄 connection_factory.go 812 B
  - 📄 connection_interface.go 1.0 KB
  - 📄 db.go 1.7 KB
  - 📄 db_util.go 1.6 KB
  - 📄 duckdb_connection.go 4.5 KB
  - 📄 firebird_connection.go 10.6 KB
  - 📄 inference.go 1.2 KB
  - 📄 metadata.go 4.0 KB
  - 📄 mysql_connection.go 8.2 KB
  - 📄 oracle_connection.go 13.6 KB
  - 📄 postgres_connection.go 11.2 KB
  - 📄 query.go 659 B
  - 📄 sqlite_connection.go 8.1 KB
  - 📄 sqlserver_connection.go 11.4 KB
- 📁 editor/
  - 📄 editor.go 1.1 KB
  - 📄 instructions.go 2.1 KB
  - 📄 tempfile.go 562 B
- 📁 initui/
  - 📄 input.go 8.8 KB
- 📁 params/
  - 📄 input.go 3.7 KB
  - 📄 parse.go 307 B
  - 📄 parse_test.go 2.7 KB
  - 📄 positional.go 598 B
  - 📄 resolve.go 1.5 KB
  - 📄 scanner.go 2.4 KB
  - 📄 substitute.go 2.1 KB
- 📁 parser/
  - 📄 parser.go 3.2 KB
- 📁 run/
  - 📄 detector.go 759 B
  - 📄 executor.go 6.9 KB
  - 📄 resolver.go 1.8 KB
  - 📄 types.go 265 B
- 📁 spinner/
  - 📄 spinner.go 1.2 KB
- 📁 styles/
  - 📄 manager.go 3.5 KB
  - 📄 schemes.go 4.8 KB
  - 📄 theme.go 589 B
- 📁 table/
  - 📄 delete_row.go 6.0 KB
  - 📄 edit_query.go 2.1 KB
  - 📄 editutils.go 2.4 KB
  - 📄 errors.go 252 B
  - 📄 export.go 9.5 KB
  - 📄 model.go 5.2 KB
  - 📄 navigation.go 8.8 KB
  - 📄 navigation_test.go 5.3 KB
  - 📄 save_query.go 3.9 KB
  - 📄 search.go 8.0 KB
  - 📄 table.go 1.3 KB
  - 📄 update.go 4.0 KB
  - 📄 update_cell.go 8.3 KB
  - 📄 view.go 13.9 KB
📄 .gitignore 218 B
📄 build-local.sh 2.4 KB
📄 CONTRIBUTING.md 2.0 KB
📄 flake.lock 1.5 KB
📄 flake.nix 1.7 KB
📄 go.mod 3.1 KB
📄 go.sum 23.7 KB
📄 LICENSE 1.0 KB
📄 README.md 10.9 KB
📄 shell.nix 830 B
📄 SKILL.md 2.9 KB

SKILL.md

# Squix Skill for AI Coding Agents

## What is Squix

Squix is a CLI tool for managing and executing SQL queries across multiple
databases (PostgreSQL, MySQL, SQLite, Oracle, SQL Server, ClickHouse, Firebird).
It stores named queries in `~/.config/squix/config.yaml`.

## Critical Rules

1. **Always use `-f` with `squix run` for SELECT queries** — without it, SELECT results open an interactive TUI; non-SELECT queries print a status message either way
2. **No inline connection flag** — must `squix switch <name>` before queries
3. **Check connection first** — run `squix status` to verify reachability

## Non-Interactive Output

```bash
squix run <query> -f json        # JSON array of objects
squix run <query> -f csv         # CSV with header row
squix run <query> -f tsv         # Tab-separated values
squix run <query> -f markdown    # Markdown table
squix run <query> -f html        # HTML table with styling
squix run <query> -f sql         # INSERT statements
squix run "SELECT 1" -f json     # Inline SQL works too
squix run --last -f csv          # Re-run last query
```

Output goes to stdout, errors to stderr. Exit code 1 on failure.
Pipe cleanly: `squix run list_users -f json > users.json`

Empty results: "No results found" on stderr, nothing on stdout.

## Setup Workflow

```bash
squix init mydb "postgresql://user:pass@localhost:5432/mydb"  # auto-infers DB type
squix switch mydb                                              # or: squix use mydb
squix add list_users "SELECT * FROM users"                     # SQL must be inline
squix run list_users -f json                                   # always use -f
```

## Explore Schema

```bash
squix explore              # List all tables (non-interactive, prints to stdout)
squix explain orders -d 2  # Show FK relationships as ASCII tree
```

## List Queries

```bash
squix list queries            # Format: ◆ <id>/<name> (<table>)
squix list queries --oneline  # Compact: <id> <name> <table>
squix list connections        # List all configured connections
```

## Parameterized Queries

Named params use `:name` syntax. Optional defaults with `:name|default`:

```bash
squix add user_by_id "SELECT * FROM users WHERE id = :user_id"
squix run user_by_id --user_id 42 -f csv    # named
squix run user_by_id 42 -f csv              # positional
```

## Status & Cleanup

```bash
squix status                 # Shows: ● postgres/mydb (schema: public) — reachable
squix remove list_users      # Delete query (no confirmation needed)
echo y | squix remove -c mydb  # Delete connection (needs confirmation)
```

## Commands to Avoid (Interactive)

- `squix run <query>` without `-f` on a SELECT — opens TUI
- `squix shell` — interactive REPL
- `squix edit` — opens `$EDITOR`
- `squix explore <table>` — opens TUI
- `squix info` — opens TUI
- `squix add <name>` without SQL — opens `$EDITOR`
- `squix run` with no args — opens `$EDITOR`

Comments 0

Latest | Hot

Please login before commenting.

Loading comments...

squix

Directory Structure

SKILL.md

Report

Notice