HypAware documentation
HypAware records sessions from your AI clients locally so you can search and query them on your host. A host is any machine the collector runs on: a laptop, a build box, a remote agent's box. You can sync your recordings to HypAware Cloud so your team can search and query them.
Quickstart
Requires Node.js 22.12 or newer on macOS, Linux or Windows.
npm i -g hypaware
hyp setupInstall HypAware using npm i -g hypaware, then run hyp setup --guide and follow its instructions.Select Sync to the cloud to sync your recordings to HypAware Cloud, or choose Local only to keep recordings on your host. Then ask your agent about your recordings:
hyp ask "From my HypAware history, where did my agents go off the rails recently?"From my HypAware history, where did my agents go off the rails recently?Use hyp --help to list commands, or hyp <command> --help for help with a
specific command. To query your recordings from an MCP client instead, see
Connect an MCP client.
Documentation by category
Installation, updates, background service, and uninstall
All topics →Every supported agent and tool, its status, and how to set it up, including CI and headless hosts
All topics →Choosing clients, capture, history imports, detaching, and skills
- Choose and check a client
- Attach and verify new activity
- Bring in existing history
- Stop capture or keep it local
Explore recordings with your agent, search, SQL, graph and vector tools, and MCP
All topics →Connect an MCP client to your recordings, locally with hyp mcp serve or remotely with an agent token
All topics →The MCP tools and prompts HypAware defines, with their CLI equivalents; tools only HypAware Cloud registers are not listed
All topics →Generate, review, and publish reports
All topics →Cloud and teamsCloud
Enrollment, sync, and remote access
All topics →What is recorded, sharing controls, session exclusions, deletion, and product telemetry
All topics →Configuration files, retention, cache, exports, and plugins
All topics →Diagnose missing recordings, sync failures, and installation problems
All topics →Complete command syntax, flags, exit behavior, and aliases
All topics →Writing a plugin? See plugin authoring.