Skip to main content

Quick Start

1

Install the CLI

Requires Python 3.10 or later.
2

Get credentials

3

Authenticate

The interactive prompt asks for your API key and tenant ID, then saves them to ~/.hydradb/config.json (file permissions 0600).
4

Verify

Configuration

Authentication

The CLI resolves credentials in this order (first match wins):
  1. Environment variables (HYDRA_DB_API_KEY, HYDRADB_TENANT_ID)
  2. Config file (~/.hydradb/config.json, written by hydradb login)

Environment Variables

Output Formats

Every command supports --output human (default, Rich-formatted tables) or --output json (machine-readable). Set the default globally:
Or per-command:

Commands

Authentication

Tenant Management

hydradb tenant delete permanently removes the tenant and all associated memories, knowledge, and graph data. This action cannot be undone.

Memory Operations

Knowledge Base

Context Retrieval (Recall)

Data Inspection

CLI Configuration

Scripting & Automation

The CLI is designed for both interactive use and scripting. Use --output json to get machine-readable output that pipes cleanly into jq, Python, or other tools:

Source & Show Support

If HydraDB CLI makes your workflow faster, please star the open-source repo that powers it. It helps keep it discoverable and motivates maintainers to keep shipping improvements.

hydradb-cli

Star on GitHub if you found it useful.