HypAware documentation

HypAware collects AI sessions and telemetry into a local, queryable history. You can keep it on your machine, export files, or sync recordings to HypAware Cloud. Both hyp and hypaware run the same CLI.

Quickstart

HypAware needs Node.js 22.12 or newer on macOS or Linux.

npm i -g hypaware
hyp setup

Setup's first question is how to collect. Sync to the cloud is the default and opens a browser sign-in; choose Local only to keep everything on this machine. Then check capture and look at what you already have:

hyp status
hyp query overview
hyp ask "From my HypAware history, where did my agents go off the rails recently?"

To switch a local-only machine to sync later, run hyp remote login.

Start here

Install and set up HypAware on your own machine, or follow team setup to join an organization.
Review recording and privacy controls, including what can leave your machine.
Search and query your history after running hyp status to check capture.

Guides by task

Install, reconfigure, update, or recover HypAware: Setup and lifecycle
Attach an AI client or import existing sessions: Clients and history
Find a conversation, inspect tool calls, or summarize activity: Querying and reports
Change retention, configure exports, or enable plugins: Configuration and storage
Keep a project private, pause recording, or delete local data: Privacy controls
Connect a machine to HypAware Cloud: Team setup
Capture in CI, containers, or an unattended server: Headless setup
Diagnose missing recordings, stale results, or failed exports: Troubleshooting
Look up exact command syntax and flags: CLI reference

How the pieces fit

Clients and telemetry sources write to the local query cache. Queries read that cache. Sinks export eligible data from it on a schedule: for example, Parquet files on disk or recordings sent to HypAware Cloud. Enabling capture and enabling export are separate choices.

Plugins provide client integrations, sources, destinations, and optional query tools. Command availability follows the active configuration. Run hyp --help and hyp plugin list to see what your installation supports.

Contributors and advanced reference

Plugin authoring: scaffold, validate, and implement a plugin.
Product telemetry: the enrollment default, its controls, what is collected, and delivery limits.

These guides describe the code in this repository. For an older installed release, use hyp version and hyp COMMAND --help to check its supported syntax. Uppercase values such as SESSION_ID in examples are placeholders.