Skip to content
Docs

Desktop App (BifrostQL.UI)

BifrostQL includes a desktop application built on Photino.NET — a lightweight native window that wraps a web view. Point it at any SQL Server and you get a GraphQL playground with zero setup.

The desktop app ships as a standalone binary:

Terminal window
dotnet tool install -g BifrostQL.UI

Or build from source:

Terminal window
pnpm install --frozen-lockfile
pnpm --dir src/BifrostQL.UI/frontend build
dotnet build src/BifrostQL.UI/BifrostQL.UI.csproj

This produces a bifrostui binary.

Pass a connection string directly:

Terminal window
bifrostui "Server=localhost;Database=mydb;User Id=sa;Password=xxx;TrustServerCertificate=True"

Or launch without one and connect through the UI:

Terminal window
bifrostui
FlagShortDescription
--port-pPort for the embedded server (default: 5000)
--expose-eBind to 0.0.0.0 instead of localhost
--headless-HServer only, no desktop window
--vault-VPath to encrypted vault file

Run BifrostQL as a standalone server without the desktop window:

Terminal window
bifrostui "Server=localhost;Database=mydb;..." --headless --port 8080

This gives you the same GraphQL endpoint and playground at http://localhost:8080/graphql and http://localhost:8080/graphiql, plus the connection management API — useful for remote servers or Docker containers.

Current desktop builds do not accept password-bearing connection strings through /api/connection/set. Passwords stay in the native host and are stored in an encrypted local vault. The UI can create vault entries through the Photino native bridge, or you can manage them from the CLI:

Terminal window
bifrostui vault add prod --provider postgres --host db.example.com --database app --username appuser
bifrostui vault list
bifrostui vault remove prod
bifrostui vault export

Use --password-stdin for automation:

Terminal window
printf '%s\n' "$DB_PASSWORD" | bifrostui vault add prod --provider postgres --host db.example.com --database app --username appuser --password-stdin

Vault entries may include SSH tunnel settings and WordPress tags. Saved entries appear on the welcome screen without exposing passwords to the renderer.

The desktop app bundles a full BifrostQL server inside a native window:

  • Provider-aware connection flow — SQL Server, PostgreSQL, MySQL, and SQLite connection forms with per-provider validation.
  • Encrypted credential vault — Saved servers are listed through /api/vault/servers; connecting uses /api/vault/connect so credentials stay server-side.
  • SSH and WordPress helpers — Optional SSH tunnels plus WordPress database credential discovery through wp-cli.
  • GraphQL playground/editor — Built-in editor at /graphiql and the React table editor loaded from the app shell.
  • SQLite quickstarts — Create local demo databases through /api/database/create-quickstart and stream progress with Server-Sent Events.
  • Transport probe — Header toggle can probe HTTP and binary WebSocket health. Editor queries still use HTTP until the editor accepts a pluggable transport.
  • Health check/api/health reports server status and connection state.

The app runs an embedded ASP.NET Core server on localhost and opens a Photino native window pointed at it. The server hosts both the BifrostQL GraphQL endpoint and a React-based frontend.

bifrostui
├── ASP.NET Core server (localhost:5000)
│ ├── /graphql — BifrostQL GraphQL endpoint
│ ├── /bifrost-ws — Binary WebSocket endpoint
│ ├── /graphiql — GraphQL playground
│ ├── /api/providers — Available database providers
│ ├── /api/connection/* — Connection testing
│ ├── /api/vault/* — Server-side credential vault
│ ├── /api/ssh/* — SSH tunnel and WordPress discovery helpers
│ ├── /api/database/* — SQLite quickstart database creation
│ └── /api/health — Health check
└── Photino native window
└── Loads http://localhost:5000

Kestrel is configured with larger request header limits (128KB) to accommodate auth tokens.

The /api/database/create-quickstart endpoint creates SQLite databases from built-in schemas and accepts a schema plus dataSize.

TemplateTablesDescription
northwindCategories, Products, Customers, Orders, OrderDetailsClassic Northwind with foreign key relationships
adventureworks-liteDepartments, Employees, Shifts, EmployeeDepartmentHistoryHR-style schema with history tracking
simple-blogUsers, Posts, Comments, Tags, PostTagsBlog with many-to-many tag relationships

Database creation streams progress via Server-Sent Events, reporting each stage with percentage updates. The legacy /api/database/create endpoint is disabled because it accepted password-bearing connection strings over HTTP.

The desktop app serves static assets from src/BifrostQL.UI/wwwroot, but those files are generated Vite output and are not tracked in git. Change the React source under src/BifrostQL.UI/frontend/src, then rebuild with:

Terminal window
pnpm --dir src/BifrostQL.UI/frontend build