Skip to content

CLI Database

github-actions[bot] edited this page Sep 1, 2026 · 1 revision

ed database

ed database is the noninteractive surface for saved connections, bounded reads, and guarded mutations. Every request crosses the same authenticated local broker boundary as the Database page. The CLI never reads the metadata store or opens a database driver directly.

The bare command runs ed database connections, which in turn runs ed database connections list.

Commands

Command What it does
ed database Runs the default connection listing.
ed database connections Lists connections by default or selects one by UUID.
ed database connections add Tests and saves a connection with credentials stored in Keychain.
ed database connections list Lists bounded saved connection summaries with server-side filters.
ed database connections get Shows one saved connection without credentials or secret references.
ed database connections test Tests one saved connection through the broker.
ed database connections edit Updates connection metadata and safety policies.
ed database connections duplicate Copies a saved connection without exposing credentials.
ed database connections rename Renames a saved connection.
ed database connections delete Deletes a saved connection after confirmation.
ed database saved-queries Lists saved queries by default.
ed database saved-queries list Lists bounded saved query summaries.
ed database saved-queries get Shows one saved query.
ed database saved-queries save Saves query text read from a file or stdin.
ed database saved-queries duplicate Copies one saved query.
ed database saved-queries rename Renames one saved query.
ed database saved-queries delete Deletes one saved query after confirmation.
ed database capabilities Shows the shared capability report, optionally refreshing discovery.
ed database connect Opens a broker session for one saved connection.
ed database disconnect Closes a broker session.
ed database browse Reads one bounded page from a database object.
ed database query Executes one bounded read query.
ed database mutations Builds, previews, applies, and reconciles guarded mutations.
ed database mutations row-request Builds a canonical PostgreSQL row request.
ed database mutations key-request Builds a canonical Redis or Valkey key request.
ed database mutations document-request Builds a canonical MongoDB document request from bounded JSON.
ed database mutations preview Produces a safety preview and confirmation document.
ed database mutations apply Applies the exact request bound to a fresh confirmation.
ed database mutations status Checks an accepted asynchronous mutation.
ed database mutations cancel Requests cancellation of an accepted mutation.
ed database mutations outcome Reads the durable mutation outcome.
ed database operations Lists tracked broker operations by default.
ed database operations list Lists bounded operation history.
ed database operations get Shows one tracked operation.
ed database operations cancel Requests cancellation of one tracked operation.
ed database mcp Serves bounded read-only connection and capability tools over MCP stdio.

Safety boundary

JSON is assembled field by field. It does not encode the stored connection definition wholesale. Authentication output contains only its kind and whether credentials are configured. TLS resources are booleans, not local resource identifiers. Secret references and authentication sources are never printed.

The live sender starts or reconnects to the Database broker and verifies the peer before sending a request. A broker timeout, unavailable runtime, unsafe peer, or interrupted response exits 4 and writes diagnostics only to stderr. Commands are not replayed automatically.

The direct list, get, and capabilities commands print payloads only when the broker marks them complete. Partial, sampled, estimated, truncated, or stale results exit 1 with an empty stdout so automation cannot mistake incomplete data for a complete result. Warnings for an otherwise complete result remain visible on stderr. MCP tool responses preserve their explicit status, completeness, warnings, and partial failures in the structured response.

Exit codes

Code Meaning
0 The requested connection or capability data printed.
1 The broker returned an invalid response or an internal database failure.
2 A UUID, list bound, or other structural request argument was invalid.
3 A requested connection, product, environment, or order name was not found.
4 The broker or requested database capability was unavailable.

Where to go next

CLI reference

Getting Started
Config
App
Extensions
Permissions
Usage
System
Music
Calendar
Clipboard
Color
Download
Apps
Tools
Shelf
Cleaner
Machines
Machines Remote
Machines Docker
Machines Files
Machines Power
Machines Workspace
Database
Attention
Brew
Companion
Emoji
Herdr
Lid Awake
Machines Terminal
Machines Thermal
Maintenance

Database

Guides

Clone this wiki locally