README.md

August 15, 2026 · View on GitHub

GoNavi Logo

GoNavi

Navigate every data source — native speed, agent-ready, zero Electron bloat.

A high-performance cross-platform database client built with Wails (Go) + React. Desktop-first. MCP-ready. ~30MB class binaries.

Release Downloads Stars License

Go Wails React Build

Language: English · 简体中文  ·  🌐 Website · ⬇ Download · ⚡ Quick Start · ✨ Features · 🤖 MCP

Sponsored by 华龙中转站 / Hualong Transfer Station


Why GoNavi?

Most database GUIs are Electron shells with megabytes of tax. GoNavi takes a different path:

Typical Electron clientGoNavi
RuntimeChromium + NodeGo + native WebView
Binary sizeHundreds of MB~30MB class
StartupHeavyFast
MemoryHigh baselineLean
AI / AgentsBolt-on or absentFirst-class MCP + multi-provider AI
Data sourcesMostly RDBMSSQL · Cache · Vector · MQ · Search · Time-series · Domestic DBs

One cockpit for MySQL, Postgres, Redis, Kafka, Milvus, OceanBase, ClickHouse…
Query, edit, audit, sync — and hand structured context to coding agents without leaking passwords off-host.


At a Glance

┌──────────────────────────────────────────────────────────────────────┐
│  GoNavi Workbench                                                    │
│  ┌─────────────┐  ┌──────────────────┐  ┌─────────────────────────┐  │
│  │ Connections │  │ Monaco SQL + AI  │  │ Virtualized DataGrid    │  │
│  │ SSH / Proxy │  │ Schema context   │  │ Batch edit · Export     │  │
│  │ Drivers     │  │ Slash commands   │  │ Txn submit / rollback   │  │
│  └─────────────┘  └────────┬─────────┘  └─────────────────────────┘  │
│                            │                                         │
│              ┌─────────────▼─────────────┐                           │
│              │  Go core · Audit · Sync   │                           │
│              │  MCP HTTP · Web Server    │                           │
│              └───────────────────────────┘                           │
└──────────────────────────────────────────────────────────────────────┘

Product screenshots

Each image is a full GoNavi application window, scaled proportionally for README display.

GoNavi full window — connections, queries, and workbench   GoNavi full window — AI assistant with schema context

GoNavi full window — new connection data-source selector

Real desktop captures · full window


✨ Key Features

🤖 AI that knows your schema

  • OpenAI · Gemini · Claude · custom OpenAI-compatible APIs
  • Attach live table schemas as context
  • Slash commands: generate SQL, explain, optimize, review
  • MCP: after detecting a locally installed CLI, one-click connect Claude Code / Codex / OpenCode / ZCode / DeepSeek Harness / Kimi Code / Grok Build, or use Streamable HTTP for remote agents
  • Secrets stay on the GoNavi host — agents get tools, not raw passwords

⚡ Built for large data

  • Virtualized DataGrid for heavy result sets
  • In-place cell edit · batch CRUD · transaction submit/rollback
  • Large-field popup editor · smart read/write modes
  • Export: CSV · XLSX · JSON · Markdown
  • Monaco editor with context-aware completion

🔌 Connectivity without drama

  • URI generate / parse
  • SSH tunnel · proxy
  • Connection JSON import / export
  • On-demand optional driver agents
  • Custom Driver + DSN extensibility

🛡️ Observable & shippable

  • SQL execution logs with timing
  • Audit center (redacted by default, retention, export)
  • Desktop + experimental Web Server mode
  • Docker / K8s / Helm / Podman packaging
  • Auto update checks · multi-arch releases

🧩 Stack

Go 1.24 · Wails v2 · React 18 · TypeScript · Vite · Ant Design 5 · Zustand · Monaco


🗄 Supported Data Sources

Built-in — ready out of the box · Optional agent — install via Driver Manager

Built-inMySQL · GoldenDB · PostgreSQL · Oracle · Redis · Chroma · Qdrant · Milvus · RocketMQ · MQTT · Kafka · RabbitMQ
OptionalMariaDB · Doris · StarRocks · Sphinx · SQL Server · SQLite · DuckDB · OceanBase · Dameng · Kingbase · HighGo · Vastbase · OpenGauss · GaussDB · IRIS · MongoDB · TDengine · IoTDB · ClickHouse · Trino · Elasticsearch · Custom Driver/DSN
Full capability matrix
CategoryData SourceDriver ModeTypical Capabilities
RelationalMySQLBuilt-inSchema browsing, SQL query, data editing, export/backup
Domestic DBGoldenDBBuilt-inMySQL-compatible query workflow and distributed transaction scenarios
RelationalPostgreSQLBuilt-inSchema browsing, SQL query, data editing, object management
RelationalOracleBuilt-inQuery execution, object browsing, data editing
CacheRedisBuilt-inKey browsing, command execution, encoding/view switch
Vector DatabaseChromaBuilt-inCollection browsing, vector retrieval, metadata filtering
Vector DatabaseQdrantBuilt-inCollection browsing, vector search, payload filtering
Vector DatabaseMilvusBuilt-inCollection browsing, vector search, scalar filtering
Message QueueRocketMQBuilt-inTopic browsing, consumer-group inspection, message-oriented workflow
Message QueueMQTTBuilt-inBroker and topic-filter workflow with QoS-aware connection settings
Message QueueKafkaBuilt-inTopic browsing, broker metadata, consumer-group workflow
Message QueueRabbitMQBuilt-inQueue/exchange browsing, virtual host inspection, management API workflow
RelationalMariaDBOptional driver agentQuerying, object management, data editing
RelationalDorisOptional driver agentQuerying, object browsing, SQL execution
Columnar AnalyticsStarRocksOptional driver agentQuerying, object browsing, SQL execution
SearchSphinxOptional driver agentSphinxQL querying and object browsing
RelationalSQL ServerOptional driver agentSchema browsing, SQL query, object management
File-basedSQLiteOptional driver agentLocal DB browsing, editing, export
File-basedDuckDBOptional driver agentLarge-table query, pagination, file-DB workflow
Domestic DBOceanBaseOptional driver agentMySQL / Oracle tenant access, object browsing, query workflow
Domestic DBDamengOptional driver agentQuerying, object browsing, data editing
Domestic DBKingbaseOptional driver agentQuerying, object browsing, data editing
Domestic DBHighGoOptional driver agentQuerying, object browsing, data editing
Domestic DBVastbaseOptional driver agentQuerying, object browsing, data editing
Domestic DBOpenGaussOptional driver agentPostgreSQL-like schema browsing, SQL query, object management
Domestic DBGaussDBOptional driver agentPostgreSQL-like schema browsing, SQL query, object management
Multi-modelInterSystems IRISOptional driver agentNamespace browsing, SQL query, object management
DocumentMongoDBOptional driver agentDocument query, collection browsing, connection management
Time-seriesTDengineOptional driver agentTime-series schema browsing and querying
Time-seriesApache IoTDBOptional driver agentStorage group / device / timeseries browsing and querying
Columnar AnalyticsClickHouseOptional driver agentAnalytical query, object browsing, SQL execution
Federated QueryTrinoOptional driver agentCross-source SQL via multiple catalogs, catalog.schema browsing, SQL execution
SearchElasticsearchOptional driver agentIndex browsing, mapping inspection, guarded REST console, JSON DSL / query_string search
ExtensibilityCustom Driver/DSNCustomExtend to more data sources via Driver + DSN

Elasticsearch REST console

Elasticsearch connections reuse the query workspace as a version-aware REST console:

  • Write Dev Tools-style METHOD /path requests with JSON bodies, or NDJSON for _bulk and _msearch; run the request at the cursor, the exact selection, or a batch in editor order.
  • Search hits can be viewed as a table while the complete HTTP response remains available as raw JSON or text.
  • A server-side allowlist accepts supported search, document, index, mapping, settings, alias, health, and limited CAT operations. Unknown and high-privilege endpoints are rejected by default.
  • Destructive operations require an expiring one-time confirmation. Connection protection still takes precedence and blocks writes as well as script-bearing reads.
  • Writes are limited to concrete indices and require Elasticsearch view_index_metadata (or manage) permission so GoNavi can verify the target before sending data; aliases and data streams are not accepted as write targets.
  • Request templates adapt document, mapping, and Bulk paths for Elasticsearch 6, 7, and 8.

This console targets Elasticsearch 6/7/8. It does not claim OpenSearch compatibility, and intentionally excludes reindex, security, snapshot, node, cluster-settings, template, pipeline, lifecycle, and other unrestricted administration APIs.


🚀 Quick Start

Prerequisites

go install github.com/wailsapp/wails/v2/cmd/wails@v2.11.0

Develop

git clone https://github.com/Syngnat/GoNavi.git
cd GoNavi

wails dev                          # full hot reload
node tools/wails-fast-dev.mjs      # faster when Go exports unchanged
node tools/wails-fast-dev.mjs --refresh-bindings  # after Go export signature changes

Build

wails build
wails build -clean   # clean build before release

Artifacts → build/bin.

Prefer a binary?

Grab the latest build from Releases
(macOS AMD64/ARM64 · Windows AMD64 · Linux WebKitGTK 4.0/4.1).

Standalone CLI

Stable and dev builds carry headless gonavi archives under the gonavi-cli_${VERSION}_${GOOS}_${GOARCH} namespace with a matching gonavi-cli_${VERSION}_checksums.txt file. Download the matching archive from the GitHub Release, verify its checksum, extract it, then run:

gonavi list-connections
gonavi query --conn CONNECTION_ID --sql 'SELECT * FROM orders LIMIT 10'
gonavi export --conn CONNECTION_ID --output orders.csv --sql 'SELECT * FROM orders'
gonavi batch --conn CONNECTION_ID --file migration.sql --allow-write

The project does not currently publish the CLI to npm. Install it directly from the verified release archive instead.

The stable workflow also generates and retains a checksum-driven WinGet manifest artifact for Syngnat.GoNavi.CLI; it must be accepted by the WinGet community repository before the package is available there. The existing desktop GoNavi package is separate. After acceptance, install with:

winget install --id Syngnat.GoNavi.CLI -e

The CLI shares the active data root with the desktop application: GONAVI_DATA_ROOT first, then ~/.gonavi/storage_root.json, then ~/.gonavi. Use a 0600 owner-only --connection-file for transient credentials; secrets are never accepted as command-line flags. Query output defaults to JSONL, while diagnostics go to stderr. Mutating SQL also requires the stored AI safety level, connection protections, and --allow-write.

For Linux containers, copy docker.cli.env.example, set the host data root and your host UID/GID, then run the CLI against the same mounted /data directory:

cp docker.cli.env.example docker.cli.env
docker compose --env-file docker.cli.env -f docker-compose.cli.yml run --rm gonavi-cli list-connections

🌐 Web Server (Experimental)

Same Go backend + React UI over HTTP — not a containerized Wails window.

go build .
.\GoNavi-Wails.exe web-server --addr 127.0.0.1:34116
  • First visit → /setup (admin password; optional Google Authenticator)
  • Bridge: window.go.* / window.runtime.* → HTTP / SSE
  • Sessions, recovery codes, login rate limits

Docker / Podman

cp docker.web-server.env.example docker.web-server.env
# set GONAVI_HOST_DATA_ROOT (absolute path)
# optional: GONAVI_WEB_PASSWORD (min 6 chars)
docker compose --env-file docker.web-server.env -f docker-compose.web-server.yml up -d

Open http://127.0.0.1:34116. Mount the active data root at /data
(connections.json, daily_secrets.json, optional drivers/).
Auth state → web_auth.json.

Do not expose an unhardened web entry to the public internet. Use reverse proxy + HTTPS in production.

Health: GET /__gonavi/healthz
Local source build: add -f docker-compose.web-server.local.yml --build.

After changing env passwords:

docker compose --env-file docker.web-server.env -f docker-compose.web-server.yml up -d --force-recreate

(docker restart does not reload env files.)


🤖 MCP & Agents

Ship schema tools to agents without shipping your vault:

cp docker.mcp-server.env.example docker.mcp-server.env
docker compose --env-file docker.mcp-server.env -f docker-compose.mcp-server.yml up -d
SurfaceEntry
MCP containerdocker-compose.mcp-server.ymlghcr.io/syngnat/gonavi-mcp-server
Web UI containerdocker-compose.web-server.ymlghcr.io/syngnat/gonavi-web-server
Podman / Quadletdeploy/podman/gonavi-mcp-server
Kubernetesdeploy/k8s/gonavi-mcp-server
Helmdeploy/helm/gonavi-mcp-server
Build-only imageDockerfile.build-envghcr.io/syngnat/gonavi-build-env

Safety defaults: remote schema-only omits execute_sql; mutating SQL requires explicit allowMutating=true.
Details: cmd/gonavi-mcp-server/README.md.

Linux build environment only

docker build -f Dockerfile.build-env -t gonavi-build-env:local .
docker run --rm -it -v "$PWD:/workspace" -w /workspace gonavi-build-env:local bash

📦 Release Pipeline

Push a v* tag → GitHub Actions builds multi-arch releases.
Notes auto-generated from merged PRs via .github/release.yaml.


🛠 Troubleshooting

Windows: missing Microsoft Edge WebView2 Runtime (common on intranet images)

The GoNavi desktop app on Windows depends on the Microsoft Edge WebView2 Runtime (a system component, not full Chrome).
Some intranet / thin / Server / LTSC images ship without it. Symptoms:

  • Process exits immediately, blank/white window
  • Errors about missing WebView2 / WebView2 Runtime
  • Installer blocked by AV or group policy

1. Check whether Runtime is installed

In PowerShell:

# Common Evergreen install path (64-bit Windows)
Test-Path "${env:ProgramFiles(x86)}\Microsoft\EdgeWebView\Application"

# Registry (a `pv` version usually means installed)
Get-ItemProperty -Path "HKLM:\SOFTWARE\WOW6432Node\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" `
  -ErrorAction SilentlyContinue |
  Select-Object pv, name

If the path is missing and registry has no pv, install the Runtime.

2. Online install (simplest)

  1. Open the official download page:
    Microsoft Edge WebView2
  2. Download the Evergreen Bootstrapper (small; needs network during install)
  3. Run as Administrator, then restart GoNavi

The Bootstrapper fails on fully air-gapped machines. Use the Evergreen Standalone Installer instead:

  1. On a machine with internet, download the matching architecture package, e.g.:
    • MicrosoftEdgeWebView2RuntimeInstallerX64.exe (most 64-bit PCs)
    • …X86.exe / …ARM64.exe as needed
  2. Copy the installer into the intranet (USB, software center, share)
  3. Install as Administrator on the target PC:
# Interactive
.\MicrosoftEdgeWebView2RuntimeInstallerX64.exe

# Silent (batch / SCCM friendly)
.\MicrosoftEdgeWebView2RuntimeInstallerX64.exe /silent /install
  1. Start GoNavi again. If it still fails, sign out or reboot Windows once.

4. Group policy / locked-down PCs

  • Needs local admin, or IT push via SCCM / software center
  • Ensure policies do not block Edge/WebView2 install or updates
  • Enterprises may pin a Fixed Version Runtime (most users should prefer Evergreen)

5. Temporary workaround: Web Server mode

If the desktop WebView cannot be installed yet, run the experimental Web Server and use a normal browser:

.\GoNavi.exe web-server --addr 127.0.0.1:34116

Open http://127.0.0.1:34116. See the Web Server section above.
Do not expose an unhardened Web endpoint to the public internet.

Tracker / discussion: #672.

macOS Gatekeeper

The next stable macOS release is gated on Developer ID signing and Apple notarization. Download the DMG from the matching GitHub Release, move GoNavi to Applications, and open it normally. Do not remove Gatekeeper quarantine metadata.

Linux: missing WebKitGTK
# Debian 13 / Ubuntu 24.04+
sudo apt-get update
sudo apt-get install -y libgtk-3-0 libwebkit2gtk-4.1-0 libjavascriptcoregtk-4.1-0

# Ubuntu 22.04 / Debian 12
sudo apt-get update
sudo apt-get install -y libgtk-3-0 libwebkit2gtk-4.0-37 libjavascriptcoregtk-4.0-18

Artifacts with -WebKit41 prefer Debian 13 / Ubuntu 24.04+.

Linux: Chinese glyphs as tofu boxes
sudo apt-get update
sudo apt-get install -y fonts-noto-cjk fonts-wqy-microhei
fc-cache -fv

💖 Sponsors

华龙中转站 Hualong Transfer Station

华龙中转站 · Hualong Transfer Station
AI API Gateway · multi-model routing · domestic high-speed endpoint

Special thanks to 华龙中转站 (Hualong Transfer Station) for sponsoring GoNavi open-source development.

What they areAn AI API Gateway that unifies multi-model access behind an OpenAI-compatible surface — so you can ship LLM features without fighting provider fragmentation and network friction.
What you getMulti-model routing · OpenAI-compatible API · domestic high-speed direct endpoint · practical for indie devs and open-source projects that need reliable LLM access
Why we recommend themGoNavi is AI/MCP-first. Stable model access is core infrastructure for coding agents, schema-aware assistants, and day-to-day development.

Looking for a solid LLM relay?
👉 https://api-fast.hualong.online/ — console, docs, and the domestic high-speed endpoint.

Hualong also sponsored a shared 50B token pool for GoNavi co-maintainers, used via API Key (not 50B per person). Rules and how to apply: Issue #671.


🤝 Contributing

Issues and PRs welcome. Branch from dev, PR against dev.


💬 Contact & Feedback

ChannelNotes
GitHub IssuesPreferred for bugs, feature requests, and docs — easier to track and reproduce
WeChatygf1140302783 (note “GoNavi”) — maintainer can invite you to the community group for discussion

For technical reports, include version, OS, and repro steps when possible. Windows blank/crash on intranet images: WebView2 guide.


⭐ Star History

Star history

License

Apache-2.0

Built for people who live in SQL, schemas, and agent loops.