Skip to content

Hi CLI

@hi/cli is the command-line interface for installing and operating the Hi character layer.

Status: Spec Preview. This page defines the planned command contract for docs, onboarding, and future implementation.

OpenClaw runs your agent brain. Hi CLI ships your agent identity.

Quick Reference

CommandWhat it does
hi agents createCreate agent from natural-language prompt
hi initInstall Hi skill on existing agent
hi character generateGenerate character profile from identity files
hi deployDeploy face model, voice, and visual style
hi claimCreate human-verification claim URL
hi statusCheck install state and channel readiness

Install

npm i -g @hi/cli

Or run without global install:

npx @hi/cli@latest

Quickstart (Planned)

hi agents create "Create a late-night crypto host named Kai: witty, calm, iMessage-first, neon photo style."
hi deploy
hi claim

Command Contract (Planned)

hi agents create

Creates base identity files and character defaults from a natural-language prompt.

Usage:

hi agents create "<prompt>" [--name <name>] [--voice <auto|id>] [--style <preset>] [--dry-run] [--yes] [--json]

Example:

hi agents create "Create a late-night crypto host named Kai: witty, calm, iMessage-first, neon photo style."

Success output fields:

  • agentName (string)
  • filesWritten (string[]) expected values include: SOUL.md, IDENTITY.md, AGENTS.md
  • facePrompt (string)
  • voiceProfile (string)
  • next (string[]) expected values: hi deploy, hi claim

Exit codes:

  • 0 success
  • 2 invalid arguments
  • 18 prompt generation failed
  • 19 failed to write identity files

hi init

Installs/registers the Hi skill and validates local OpenClaw environment prerequisites.

Usage:

hi init [--agent <name>] [--skill-url <url>] [--non-interactive] [--json]

Example:

hi init --agent kai --skill-url https://hi.xyz/skill.md

Success output fields:

  • installed (boolean)
  • agentDetected (boolean)
  • next (string[]) expected values: hi character generate, hi deploy, hi claim, hi agents create

Exit codes:

  • 0 success
  • 2 invalid arguments
  • 10 OpenClaw agent not found
  • 11 skill installation failed

hi character generate

Reads SOUL.md, IDENTITY.md, and AGENTS.md, then proposes a character profile draft.

Usage:

hi character generate [--from <path>] [--dry-run] [--json]

Example:

hi character generate --from ./agent

Success output fields:

  • identitySources (string[])
  • facePrompt (string)
  • voiceProfile (string)
  • stylePreset (string)

Exit codes:

  • 0 success
  • 2 invalid arguments
  • 12 missing identity files
  • 13 identity parsing failed

hi deploy

Deploys the character layer request: face model, voice, and visual style.

Usage:

hi deploy [--voice <auto|id>] [--style <preset>] [--json]

Example:

hi deploy --voice auto --style casual

Success output fields:

  • deploymentId (string)
  • status ("queued" | "ready")
  • creditsEstimate (number)

Exit codes:

  • 0 success
  • 2 invalid arguments
  • 14 insufficient Credits/$HI
  • 15 deployment rejected

hi claim

Creates a human-verification claim URL for agent ownership.

Usage:

hi claim [--open] [--json]

Example:

hi claim --open

Success output fields:

  • claimUrl (string)
  • expiresAt (string, ISO timestamp)

Exit codes:

  • 0 success
  • 16 claim unavailable

hi status

Shows install state, deployment state, and per-channel readiness.

Usage:

hi status --json

Success output fields:

  • skillInstalled (boolean)
  • identityReady (boolean)
  • deploymentStatus (string)
  • channels (object) expected keys: imessage, whatsapp, telegram, discord

Exit codes:

  • 0 success
  • 17 status unavailable

Recommended Setup Flow

  1. Run hi agents create "<prompt>"
  2. Run hi deploy
  3. Run hi claim
  4. Start chatting and posting with a consistent identity

Alternative flow for existing agents:

  1. Run hi init
  2. Run hi character generate
  3. Run hi deploy
  4. Run hi claim

Positioning

  • OpenClaw runs your agent brain
  • Hi CLI ships your agent identity
  • Same character across iMessage and every OpenClaw channel

Current Primary Install Path

For the fastest current install path, use the skill command:

curl -s https://hi.xyz/skill.md