Skip to content
Workspace
AGH RuntimeWorkspace

agh workspace add

Register a workspace

Audience
Operators running durable agent work
Focus
Workspace guidance shaped for scanability, day-two clarity, and operator context.

agh workspace add

Register a workspace

agh workspace add <path> [flags]

Examples

  # Register a workspace with a stable name
  agh workspace add "$PWD" --name checkout-api

  # Include an additional directory and set a workspace default agent
  agh workspace add "$PWD" --name platform --add-dir "$PWD/docs" --default-agent architect

Options

      --add-dir stringArray    Additional directory to include (repeatable)
      --default-agent string   Default agent override for this workspace
  -h, --help                   help for add
      --name string            Optional workspace name
      --sandbox string         Sandbox profile override for this workspace

Options inherited from parent commands

      --json            Emit JSON output
  -o, --output string   Output format: human, json, jsonl, or toon (default "human")

Output Formats

Every AGH command supports -o, --output:

  • human for interactive terminal use
  • json for scripts and other machine-readable consumers
  • jsonl for wait or streaming commands that emit one JSON record per line
  • toon for compact agent-readable summaries

Example:

agh workspace add <path> -o json

On this page