Skip to content

wordbricks/onequery

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

237 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OneQuery

English | 中文

npm downloads Site Release License

Self-host OneQuery to connect databases, analytics tools, and APIs, manage credentials centrally, and run safe, auditable queries from a CLI and web UI.

One interface for your whole data stack, with built-in safeguards and a simpler workflow for your team.


Features

Self-Host Cloud / Enterprise
Safe querying Read-only validation, single-statement enforcement
Query cost limit Budget caps for BigQuery, Athena, etc.
Audit log Full query history and tracking
Auth / Org / RBAC Organization-level access control SSO, SAML
Connection vault Centralized credential management
Connectors 15+ sources
NL → SQL
Insights
SLA / Compliance

Quick Install

npm install -g @onequery/cli

Other install options:

brew install wordbricks/tap/onequery    # Homebrew
bun add -g @onequery/cli                # Bun
curl -fsSL https://onequery.dev/install.sh | sh    # install script

Without a global install: npx @onequery/cli --help or bunx @onequery/cli --help.


Getting Started

Option A: Self-host (run your own server)

onequery gateway start
onequery auth login

Add a source and run a query:

onequery source connect --source postgres \
  --input '{"name":"warehouse","credentials":{"host":"db.example.com","database":"app","username":"onequery","password":"secret"}}'
onequery query execute --source postgres://warehouse --sql "select 1"

Connected sources are referenced as <provider>://<source-key>, for example postgres://warehouse.

Option B: Connect to an existing server

onequery config set server https://onequery.example.com
onequery auth login
onequery source list
onequery query execute --source <provider>://<source-key> --sql "select 1"

Supported Sources

PostgreSQL · Supabase · MySQL · Snowflake · MongoDB · BigQuery · AWS Athena · Google Analytics · Amplitude · Mixpanel · PostHog · Sentry · GitHub · Linear · Laminar

Run onequery source connect --help for provider-specific setup.


Documentation

Document Description
Self-Hosting Guide Install, proxy, SMTP, storage, backup, restore, upgrade
Architecture System design, monorepo structure, runtime surfaces
CLI Reference CLI workspace, config, and runtime behavior
Env & Secrets Managed local config flow for the web/server workspace

Claude Code Plugin

The onequery Claude Code plugin ships from the Wordbricks marketplace:

/plugin marketplace add wordbricks/skills
/plugin install onequery@wordbricks

For skills-compatible agents, install the onequery-cli skill:

npx skills add https://github.com/wordbricks/skills --skill onequery-cli -y

OpenClaw Plugin

The OpenClaw plugin bundles the onequery-openclaw skill so agents can use the onequery CLI directly through OpenClaw's built-in exec tool.

Install from ClawHub explicitly:

openclaw plugins install clawhub:@onequery/openclaw-plugin
openclaw plugins enable onequery

Install from npm (OpenClaw also checks ClawHub first for bare package specs):

openclaw plugins install @onequery/openclaw-plugin
openclaw plugins enable onequery

Install from a checkout of this repository:

bun run --cwd packages/openclaw-plugin build
openclaw plugins install -l ./packages/openclaw-plugin
openclaw plugins enable onequery

If you want to inspect the published package through the separate ClawHub CLI first:

clawhub package inspect @onequery/openclaw-plugin

If your setup persists plugin entries in openclaw.json, make sure the plugin is enabled there too:

{
  plugins: {
    entries: {
      onequery: { enabled: true },
    },
  }
}

After enabling the plugin, start a new session so OpenClaw reloads the bundled skill.

Hermes

For plugin-free Hermes Agent usage, install the standalone onequery-cli skill:

hermes skills install skills-sh/wordbricks/skills/onequery-cli --yes --force

Then start Hermes with the skill preloaded:

hermes chat --skills onequery-cli

Or load it inside an existing Hermes session:

Load skill onequery-cli.

Built With

Libraries that make OneQuery more reliable:

  • better-result: Forces every failure to be handled explicitly, so errors never silently slip through.
  • antiox: Keeps concurrent queries, timeouts, and cancellations predictable, with no leaked tasks or hanging connections.
  • XState: Models complex dashboard workflows as explicit state machines, keeping UI transitions testable and predictable.
  • proptest: Exercises Rust runtime state machines and path invariants with generated cases instead of hand-picked examples.
  • connect-rust: Provides Tower-based Rust Connect RPC support across Connect, gRPC, and gRPC-Web.
  • polyglot: Parses, transpiles, and formats SQL across 32+ dialects, keeping cross-database query handling consistent.

Contributing

We welcome contributions across the project. See CONTRIBUTING.md for the PR process.


License

Apache 2.0. See LICENSE.