HyperoruDocumentation

Getting started

Create a workspace, connect a source, run your first review, and explore the resulting architectural truth.

Hyperoru turns technical evidence into a reviewable architecture model. A first review follows five short steps.

1. Create your workspace

Accept your invitation, verify your email, and create a workspace for the team that owns the system being reviewed. Workspace roles control who can connect sources, run reviews, approve reports, and publish remediation.

2. Connect evidence

Choose the connection that fits your workflow:

3. Start a review

Choose a connected source and start an audit. Hyperoru admits work to the workspace queue, reports its position, and streams each deterministic and agent-assisted stage as it completes.

4. Inspect the result

Open the architecture view to explore:

  • services, data stores, interfaces, pipelines, identities, and boundaries;
  • relationships with selectable evidence and confidence;
  • contradictions and coverage gaps;
  • findings connected to their architectural context;
  • the specialist-agent artifacts that shaped the review.

5. Share or act

Review the canonical report, approve it, and export JSON, Markdown, DOCX, or PDF. When remediation is appropriate, an Analyst can approve a proposed change and publish a pull request. Hyperoru never merges automatically.

Prefer the API?

Use the API guide for authentication, idempotency, event streams, errors, and the generated endpoint reference.

On this page