Skip to content
Workspace
AGH RuntimeWorkspace

agh workspace edit

Edit a registered workspace

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

agh workspace edit

Edit a registered workspace

agh workspace edit <name-or-id> [flags]

Examples

  # Rename a workspace
  agh workspace edit checkout-api --name checkout

  # Clear the workspace default agent
  agh workspace edit checkout-api --default-agent ""

Options

      --add-dir stringArray      Additional directory to include (repeatable)
      --default-agent string     Override the workspace default agent (set empty to clear)
  -h, --help                     help for edit
      --name string              Rename the workspace
      --remove-dir stringArray   Additional directory to remove (repeatable)
      --sandbox string           Override the workspace sandbox profile (set empty to clear)

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 edit <name-or-id> -o json

On this page