Installation

Install the Hyperfold CLI and SDK to start building agentic commerce applications.

Prerequisites: You'll need a Hyperfold account, a GCP project (auto-created), and a Stripe account for payment processing.

CLI Installation

The hyperfold CLI is the command center for Headless Agentic Commerce. It treats agentic commerce as Infrastructure as Code (IaC).

bash

# Install the Hyperfold CLI
curl -fsSL https://hyperfold.dev/install | bash
 
# Verify installation
hyperfold --version

The installation script detects your operating system and installs the appropriate binary. Supported platforms:

macOS: Intel and Apple Silicon (M1/M2/M3)
Linux: x86_64 and ARM64
Windows: x86_64 (WSL2 recommended)

Manual Installation

If you prefer manual installation, download the binary directly from the releases page:

bash

# Intel Mac
curl -L https://hyperfold.dev/cli/darwin-amd64 -o /usr/local/bin/hyperfold
 
# Apple Silicon
curl -L https://hyperfold.dev/cli/darwin-arm64 -o /usr/local/bin/hyperfold
 
chmod +x /usr/local/bin/hyperfold

Authentication

The login command establishes a secure authenticated session with Hyperfold Cloud (GCP) and links your local environment to your Stripe account.

bash

$ hyperfold login
> Initiating Hyperfold Identity Service...
> Please visit: https://hyperfold.io/activate?code=HAC-9921
> Waiting for authentication... [|]
> [SUCCESS] Authenticated as: dev@hyperfold.io
> [INFO] Default Organization: Hyperfold Global (org_8812)
> [INFO] Active Project: None

After running the command, you'll be prompted to visit a URL in your browser to complete authentication. Once authenticated, your credentials are stored securely in ~/.hyperfold/credentials.

Project Setup

The init command scaffolds a new local configuration for an Agentic Store, provisioning necessary GCP resources like Cloud Spanner and Vertex AI.

bash

$ hyperfold init my-agent-store --region=us-central1 --template=saas-retail
> [GCP] Creating Project: my-agent-store-prod...
> [API] Enabling Vertex AI API... Done.
> [API] Enabling Cloud Spanner API... Done.
> [Stripe] Linking Sandbox Account (acct_1Gq...)...
> [Config] Writing hyperfold.yaml...
> [SUCCESS] Project initialized.

Available Templates

Template	Description
`saas-retail`	Standard B2C retail with negotiation agents
`b2b-wholesale`	B2B with delegated payments and restock agents
`marketplace`	Multi-vendor marketplace with seller agents
`minimal`	Bare-bones setup for custom implementations

Configuration File

The initialization creates a hyperfold.yaml configuration file in your project root:

yaml

# hyperfold.yaml
project: my-agent-store
region: us-central1
template: saas-retail
 
agents:
  default_model: gpt-4o
  max_instances: 10
 
payments:
  provider: stripe
  sandbox: true
 
integrations:
  - type: shopify
    enabled: false

SDK Installation

The Hyperfold Actions SDK provides a high-level Python framework for defining Agents and binding their behavior to Commerce Lifecycle Events.

pip install hyperfold-sdk

The SDK requires Python 3.9 or higher. It works alongside the OpenAI Agents SDK for LLM-based reasoning capabilities.

Additional Dependencies

For full functionality, you may also want to install these optional packages:

bash

# OpenAI Agents SDK for LLM reasoning
pip install openai-agents
 
# Google Cloud SDK for Vertex AI
pip install google-cloud-aiplatform
 
# Stripe SDK for payment processing
pip install stripe

Verify Installation

Verify that everything is installed correctly:

bash

# Check CLI version
hyperfold --version
# Output: Hyperfold CLI v1.2.0
 
# Check authentication
hyperfold whoami
# Output: dev@hyperfold.io (org_8812)
 
# Check Python SDK
python -c "import hyperfold; print(hyperfold.__version__)"
# Output: 1.0.0

Installation complete! Continue to Your First Agent to deploy your first negotiator agent.