HypAware CLI command reference

This reference documents the visible commands shipped with HypAware. It uses the canonical hyp spelling. The hypaware binary accepts the same arguments.

For task guides, start at the documentation index. This reference defines command syntax and behavior; the guides explain common workflows. Removed commands and their replacements are listed by version in the upgrade notes.

Read command syntax

In syntax blocks, angle brackets mark required values and square brackets mark optional values. Replace uppercase values in examples with values for your environment. Don't type the brackets.

Most usage errors return exit code 2. Operational failures usually return exit code 1. A command can define a more specific contract, which this page notes where stable. Use --help on any visible command to read the help for your installed version.

Plugin-owned commands

Core commands and core group headings remain visible. Plugin-owned subcommands appear in help and can run only when their plugin is active in the effective configuration. A visible group heading does not mean every subcommand is enabled. If an inactive plugin owns a command you enter, HypAware names the plugin and prints a repair instruction.

The examples below assume their owning plugins are enabled in the effective configuration. Listing a plugin in this reference doesn't enable it. Add it to plugins[] in your configuration and configure any dependencies it requires. Use hyp config validate to check the configuration and hyp plugin list to inspect plugin status. A successful --help check only verifies the help page; it doesn't prove the plugin can run.

This reference identifies each plugin-owned family:

• session ...: shared commands provided by @hypaware/ai-gateway, @hypaware/opencode, @hypaware/pi, @hypaware/droid, @hypaware/grok, @hypaware/cursor, @hypaware/copilot, @hypaware/nanoclaw, @hypaware/langgraph, or @hypaware/antigravity (also Antigravity Desktop).
• query grep: @hypaware/grep.
• github ...: @hypaware/github.
• ollama ...: @hypaware/ollama.
• codex-cloud ...: @hypaware/codex-cloud (beta).
• client claude-account ...: @hypaware/claude-account.
• client claude-desktop ...: @hypaware/claude-desktop.
• graph ... and query graph neighbors: @hypaware/context-graph.
• query vector ... and vector status: @hypaware/vector-search.
• enrichment ...: @hypaware/context-graph-enrich.

Internal credential and client-hook commands are excluded from this user reference.

Command groups

• Set up and inspect HypAwarehyp setup, hyp status, hyp ask
• Query recorded datahyp query overview, hyp query sql, hyp query grep, hyp query schema, hyp query graph neighbors, hyp query vector search
• Generate and manage reportshyp report generate, hyp report save, hyp report publish, hyp report recommend, hyp report list, hyp report get, hyp report fix, hyp report mark, hyp report delete
• Send data nowhyp sync
• Control the current sessionhyp session status, hyp session ignore, hyp session unignore
• Manage AI clientshyp client status, hyp client attach, hyp client detach, hyp client discover, Client skill commands, Claude account commands, Claude Desktop commands
• Codex Cloud collection (beta)
• Cursor Cloud collection (beta)
• Import past client historyhyp backfill, hyp backfill list, Scheduled recovery sweeps and backfill.window_days
• Collect GitHub activityhyp github login, hyp github logout, hyp github status, hyp github backfill, hyp github sync
• Collect Linear activity
• Record Ollamahyp ollama setup, hyp ollama verify
• Control privacyhyp privacy show, hyp privacy set, hyp privacy unset, hyp privacy list, hyp privacy ignore, hyp privacy unignore, hyp privacy client, hyp privacy folders, hyp privacy purge
• Connect to or leave HypAware Cloudhyp join, hyp leave
• Manage the daemonhyp daemon install, hyp daemon uninstall, hyp daemon run, hyp daemon start, hyp daemon status, hyp daemon stop, hyp daemon restart
• Validate configurationhyp config validate
• Manage the local cachehyp cache status, hyp cache refresh, hyp cache maintain
• Maintain exportshyp sink maintain
• Manage pluginshyp plugin install, hyp plugin list, hyp plugin info, hyp plugin outdated, hyp plugin update, hyp plugin remove
• Manage remote query targetshyp remote add, hyp remote login, hyp remote mint, hyp remote tokens, hyp remote tokens revoke, hyp remote list, hyp remote remove
• Serve MCP toolshyp mcp serve
• Build and maintain the activity graphhyp graph project, hyp graph compact
• Inspect vector indexeshyp vector status
• Enrich the activity graphhyp enrichment propose, hyp enrichment curate, hyp enrichment backfill, hyp enrichment status
• Update HypAwarehyp update
• Control product telemetryhyp telemetry
• Print version informationhyp version
• Develop pluginshyp dev plugin new, hyp dev plugin doctor
• Use canonical command names