Metadata-Version: 2.4
Name: hydradb-cli
Version: 0.1.0
Summary: Agent-friendly CLI for HydraDB — memory, recall, and ingestion from the terminal
Author-email: HydraDB <founders@hydradb.com>
License: 
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to the Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by the Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding any notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           Copyright 2025 HydraDB Contributors
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://hydradb.com/
Project-URL: Documentation, https://docs.hydradb.com/
Project-URL: Repository, https://github.com/usecortex/hydradb-cli
Keywords: hydradb,cli,ai,memory,recall,agent
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Environment :: Console
Classifier: Typing :: Typed
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer<1,>=0.9
Requires-Dist: httpx>=0.24
Requires-Dist: rich>=13.0
Provides-Extra: dev
Requires-Dist: ruff>=0.4; extra == "dev"
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Dynamic: license-file

# HydraDB CLI

Command-line interface for [HydraDB](https://hydradb.com) — manage memories, recall knowledge, and run ingestion directly from the terminal.

---

## Table of Contents

- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Authentication](#authentication)
- [Configuration](#configuration)
- [Commands](#commands)
  - [Global Options](#global-options)
  - [login / logout / whoami](#login--logout--whoami)
  - [tenant](#tenant)
  - [memories](#memories)
  - [knowledge](#knowledge)
  - [recall](#recall)
  - [fetch](#fetch)
  - [config](#config)
- [Environment Variables](#environment-variables)
- [Running Tests](#running-tests)
- [License](#license)

---

## Prerequisites

| Requirement | Details |
|-------------|---------|
| **Python**  | 3.10 or higher |
| **pip**     | Latest recommended (`python -m pip install --upgrade pip`) |
| **HydraDB API Key** | Obtain from your HydraDB dashboard |
| **Tenant ID** | Required for most API operations |
| **Network access** | Must be able to reach `https://api.hydradb.com` (or your custom base URL) |

The CLI installs three runtime dependencies automatically: `typer`, `httpx`, and `rich`.

---

## Installation

### 1. Clone the repository

```bash
git clone https://github.com/usecortex/hydradb-cli.git
cd hydradb-cli
```

### 2. Create and activate a virtual environment (recommended)

```bash
python -m venv venv
source venv/bin/activate        # macOS / Linux
# venv\Scripts\activate         # Windows
```

### 3. Install the package

```bash
pip install .
```

For development (editable install so local changes take effect immediately):

```bash
pip install -e .
```

### 4. Verify the installation

```bash
hydradb --version
# hydradb-cli 0.1.0
```

If `hydradb` is not found, make sure your virtual environment is activated or that your Python scripts directory is on your `PATH`.

---

## Authentication

Before using any data commands you need to provide your API key and tenant ID. There are two ways to do this:

### Option A — `hydradb login` (persistent)

Credentials are saved to `~/.hydradb/config.json` (file permissions set to `0600`).

```bash
# Interactive — prompts for the API key
hydradb login --tenant-id YOUR_TENANT_ID

# Non-interactive
hydradb login --api-key YOUR_API_KEY --tenant-id YOUR_TENANT_ID

# Optionally set sub-tenant and a custom API base URL
hydradb login --api-key YOUR_API_KEY --tenant-id YOUR_TENANT_ID \
              --sub-tenant-id SUB_TENANT \
              --base-url https://custom.api.endpoint
```

### Option B — Environment variables (session-only)

```bash
export HYDRA_DB_API_KEY=your_api_key
export HYDRA_DB_TENANT_ID=your_tenant_id
```

Environment variables take precedence over the config file when both are set.

### Verify your session

```bash
hydradb whoami
```

Displays your resolved API key (masked), tenant ID, base URL, config file path, and whether each value came from the config file or an environment variable.

### Log out

```bash
hydradb logout
```

Deletes `~/.hydradb/config.json`.

---

## Configuration

The CLI reads settings from two sources (env vars override the file):

| Source | Location |
|--------|----------|
| Config file | `~/.hydradb/config.json` |
| Environment | See [Environment Variables](#environment-variables) |

You can view or update the config file through the CLI:

```bash
# Show current configuration
hydradb config show

# Set a single value
hydradb config set <key> <value>
```

Valid keys: `api_key`, `tenant_id`, `sub_tenant_id`, `base_url`.

---

## Commands

### Global Options

These flags go **before** the subcommand:

| Flag | Description |
|------|-------------|
| `--version` / `-v` | Print the CLI version and exit |
| `--output` / `-o` | Output format: `human` (default) or `json` |

Every command supports JSON output, which is useful for scripting and piping:

```bash
hydradb -o json memories list
hydradb -o json recall full "pricing" | jq '.chunks[0].chunk_content'
```

---

### login / logout / whoami

Manage your CLI session credentials.

| Command | What it does |
|---------|--------------|
| `hydradb login` | Saves API key and tenant info to `~/.hydradb/config.json`. Prompts for the key interactively if `--api-key` is omitted in a TTY session. Validates the key against the API when a tenant ID is provided. |
| `hydradb logout` | Removes the stored config file. |
| `hydradb whoami` | Prints the active API key (masked), tenant ID, sub-tenant ID, base URL, config path, and where each value was resolved from. |

---

### tenant

Create, monitor, and manage HydraDB tenants.

| Command | What it does | Key options |
|---------|--------------|-------------|
| `tenant create <tenant_id>` | Provisions a new tenant via `POST /tenants/create`. | `--embeddings`, `--embeddings-dimension` |
| `tenant monitor [tenant_id]` | Returns status and usage statistics for a tenant. Uses the default tenant when the argument is omitted. | — |
| `tenant list-sub-tenants [tenant_id]` | Lists all sub-tenant IDs under a tenant. | — |
| `tenant delete <tenant_id>` | Permanently deletes a tenant. Asks for confirmation. | `--yes` / `-y` to skip prompt |

```bash
hydradb tenant create my-new-tenant
hydradb tenant monitor
hydradb tenant list-sub-tenants
hydradb tenant delete old-tenant --yes
```

---

### memories

Store and manage user-level memories (preferences, notes, context).

| Command | What it does | Key options |
|---------|--------------|-------------|
| `memories add` | Adds a new user memory. Text can come from `--text`, stdin, or `-` for piped input. By default the API infers structured data from the text. | `--text`, `--title`, `--source-id`, `--user-name`, `--markdown`, `--infer` / `--no-infer`, `--upsert` / `--no-upsert` |
| `memories list` | Lists all stored user memories for the current tenant. | — |
| `memories delete <memory_id>` | Deletes a single memory by ID. | `--yes` / `-y` |

```bash
hydradb memories add --text "User prefers dark mode and weekly email summaries"
hydradb memories add --text "Raw meeting notes..." --no-infer --title "Meeting Notes"
hydradb memories add --text "# Preferences\n- Dark mode" --markdown
hydradb memories list
hydradb memories delete mem_abc123 --yes
```

---

### knowledge

Upload, verify, and delete knowledge sources (files or raw text).

| Command | What it does | Key options |
|---------|--------------|-------------|
| `knowledge upload <files...>` | Uploads one or more files (PDF, DOCX, TXT, etc.) for ingestion. | `--upsert` |
| `knowledge upload-text` | Uploads plain text content directly without a file. | `--text` / `-t`, `--title`, `--source-id` |
| `knowledge verify <ids...>` | Checks the processing status of previously uploaded sources. | — |
| `knowledge delete <ids...>` | Deletes one or more knowledge sources. | `--yes` / `-y` |

```bash
hydradb knowledge upload ./contract.pdf ./notes.docx
hydradb knowledge upload ./updated-report.pdf --upsert
hydradb knowledge upload-text --text "Q4 pricing: Starter $29, Pro $79" --title "Pricing"
hydradb knowledge verify source_abc123
hydradb knowledge delete source_abc123 source_def456 --yes
```

---

### recall

Search and retrieve information from your knowledge base or user memories.

| Command | What it does | Key options |
|---------|--------------|-------------|
| `recall full <query>` | Semantic search over knowledge/documents. Returns ranked chunks. | `--max-results` / `-n`, `--mode` / `-m` (`fast` or `thinking`), `--alpha`, `--recency-bias`, `--graph-context` / `--no-graph-context`, `--context` |
| `recall preferences <query>` | Semantic search scoped to user memories. | Same as `full` |
| `recall keyword <query>` | Keyword / boolean search across sources or memories. | `--operator` (`or`, `and`, `phrase`), `--search-mode` (`sources` or `memories`), `--max-results` |

```bash
hydradb recall full "What did the team say about pricing?"
hydradb recall full "contract terms" --mode thinking --max-results 20
hydradb recall preferences "What does the user prefer?"
hydradb recall keyword "pricing AND enterprise" --operator and
```

---

### fetch

Inspect ingested sources, retrieve content, and explore knowledge graph relationships.

| Command | What it does | Key options |
|---------|--------------|-------------|
| `fetch sources` | Lists all ingested data sources. | `--kind` (`knowledge` or `memories`), `--page`, `--page-size` |
| `fetch content <source_id>` | Fetches the full content of a source, a presigned download URL, or both. | `--mode` (`content`, `url`, `both`) |
| `fetch relations <source_id>` | Returns knowledge graph triplets (subject → predicate → object) linked to a source. | `--is-memory` / `--is-knowledge`, `--limit` |

```bash
hydradb fetch sources
hydradb fetch sources --kind knowledge --page-size 10
hydradb fetch content source_abc123
hydradb fetch content source_abc123 --mode url
hydradb fetch relations source_abc123
```

---

### config

View and update CLI configuration values without editing the config file manually.

| Command | What it does |
|---------|--------------|
| `config show` | Displays all current settings (API key is masked). |
| `config set <key> <value>` | Sets a single configuration value. Valid keys: `api_key`, `tenant_id`, `sub_tenant_id`, `base_url`. |

```bash
hydradb config show
hydradb config set tenant_id my-tenant
hydradb config set base_url https://api.hydradb.com
```

---

## Environment Variables

| Variable | Purpose |
|----------|---------|
| `HYDRA_DB_API_KEY` | API key (overrides config file) |
| `HYDRA_DB_TENANT_ID` | Default tenant ID (overrides config file) |
| `HYDRA_DB_SUB_TENANT_ID` | Default sub-tenant ID (overrides config file) |
| `HYDRA_DB_BASE_URL` | API base URL (overrides config file, default `https://api.hydradb.com`) |
| `HYDRADB_OUTPUT` | Default output format — `human` or `json` |

---

## Running Tests

Tests use `pytest` and live in the `tests/` directory.

```bash
pip install -e .          # editable install so tests can import the package
pytest                    # runs all tests
```

---

## License

Apache 2.0 — see [LICENSE](LICENSE) for details.
