CLI Reference

The Hyperfold CLI is your primary interface for managing agents, catalogs, and commerce operations.

Introduction

The hyperfold command-line interface provides complete control over your agentic commerce infrastructure. From importing product catalogs to deploying agents and monitoring negotiations, the CLI is designed for both interactive use and CI/CD automation.

The CLI follows Infrastructure as Code (IaC) principles—your entire commerce setup can be version-controlled, reviewed, and deployed programmatically.

CLI Philosophy

The Hyperfold CLI is built on several key principles:

Declarative Configuration

Define desired state in YAML files. The CLI reconciles current state with your declarations, making changes only where necessary.

Idempotent Operations

Running the same command twice produces the same result. Safe for automated pipelines and retries.

Progressive Disclosure

Simple commands for common tasks, with advanced options available when needed. Sensible defaults get you started quickly.

Scriptable Output

Every command supports JSON output for parsing in scripts. Human-readable output is the default for interactive use.

Command Structure

Commands follow a consistent group → command → options structure:

$ hyperfold <group> <command> [options]
GROUPS:
  catalog      Product catalog management
  agent        Agent deployment and configuration
  pay          Payment configuration and tokenization
  fulfill      Fulfillment provider management
  integrate    ERP and external system integrations
  workflow     Multi-step workflow orchestration
  sim          Simulation and testing
  config       CLI and project configuration
  logs         Log streaming and analysis

Getting Help

Every command includes built-in documentation:

# Get help for any command
$ hyperfold --help
$ hyperfold catalog --help
$ hyperfold catalog product-import --help
# Version information
$ hyperfold --version
hyperfold-cli/1.2.0 linux-x64 node-v20.10.0

Global Options

These options are available for all commands:

Option	Description
`--project`	Override the default project ID
`--env`	Target environment (development, staging, production)
`--output`	Output format: json, table, or default
`--quiet`	Suppress non-essential output
`--verbose`	Show detailed operation logs
`--dry-run`	Preview changes without applying them
`--help`	Show help for the command

Output Formats

# Default: human-readable output
$ hyperfold agent list
# JSON output for scripting
$ hyperfold agent list --output=json
# Table format
$ hyperfold agent list --output=table
# Quiet mode (IDs only)
$ hyperfold agent list --quiet

Configuration

The CLI stores configuration in ~/.hyperfold/config.yaml and project-specific settings in ./hyperfold.yaml:

# View current configuration
$ hyperfold config show
PROJECT CONFIGURATION
  Project ID:     proj_acme_sports
  Environment:    development
  Region:         us-central1
AUTHENTICATION
  Service Account: hyperfold-sa@acme-sports.iam.gserviceaccount.com
  Token Expires:   2025-12-20T10:30:00Z
ACTIVE INTEGRATIONS
  ✓ Shopify (shop_xyz)
  ✓ Stripe (acct_abc)
  ○ Salesforce (not configured)

Never commit ~/.hyperfold/credentials.json to version control. Use environment variables or secret management for CI/CD.

Ready to start? See Authentication to connect your CLI to Hyperfold.

Search Documentation