Docs/HyperAgent/Getting Started

Getting Started

Use this guide for the HyperAgent workflow as documented on this site. Product releases follow the HyperAgent repository (currently v0.1.0 closed beta). Strategy and layer definitions follow the Hyperkit whitepaper v1.2.0. The docs site version in the header is only the documentation build label.

Current Scope

HyperAgent is currently documented as a workflow system for smart contract delivery, not as a general-purpose builder for every chain and every product category. The current Studio path is centered on supported SKALE Base flows, wallet-based identity, BYOK configuration, workflow execution, verification, and x402-backed payment handling where supported.

Scope Boundary

Read the current product as an implemented MVP lane plus a broader architecture roadmap. The current docs should not be read as proof that every chain, service, or deployment mode is equally mature today.

Prerequisites

Node.js and package manager

Required for the Studio application and local documentation workflow.

Wallet access

Needed for the current Studio identity and deployment path on supported SKALE Base flows.

BYOK provider keys

OpenAI, Anthropic, Google, OpenRouter, or another supported provider through the Settings flow.

Local Setup

For this documentation site repository, use:

Terminal

npm install
npm run dev

To run HyperAgent Studio from source, clone the product monorepo (pnpm8+, Node 18+ per upstream README):

Terminal

git clone https://github.com/Hyperkit-Labs/hyperagent.git
cd hyperagent
pnpm install
pnpm --filter hyperagent-studio dev

For day-to-day product usage, the Studio path is user-facing rather than install-first. The high-level flow is:

Connect wallet

Use the current Studio identity and payment path on supported SKALE Base networks.

Configure BYOK

Add provider keys in Settings and validate them before starting a workflow.

Run workflow

Start a workflow that moves through specification, generation, audit, Tenderly simulation, and deploy preparation or deploy when gates allow.

Studio Flow

The current Studio flow is designed to make workflow state legible. Teams should be able to see:

the current workflow stage
generated contract artifacts
verification and simulation outputs
deployment records and explorer links
payment and BYOK configuration status

What You Get

The current workflow output should be understood as a deployment-aware, verification-backed starter result. It is not a claim of final launch completeness. The active product path is intended to produce generated artifacts, verification output, deployment preparation, and handoff-ready workflow state that a real team can review and extend.