Skip to main content

hjk config

View and modify Headjack configuration.

Synopsis

hjk config [key] [value] [flags]

Description

View and modify Headjack configuration:

  • No arguments: Display all configuration
  • One argument: Display the value for the specified key
  • Two arguments: Set the value for the specified key

Arguments

ArgumentDescription
keyConfiguration key in dot notation (e.g., default.agent) (optional)
valueValue to set for the key (optional, requires key)

Flags

FlagTypeDefaultDescription
--editboolfalseOpen config file in $EDITOR

Inherited Flags

FlagTypeDescription
--multiplexerstringTerminal multiplexer to use (tmux, zellij)

Examples

# Show all configuration
hjk config

# Show value for a specific key
hjk config default.agent

# Set a value
hjk config default.agent claude

# Open config file in editor
hjk config --edit

Configuration Keys

Common configuration keys:

KeyTypeDescription
default.agentstringDefault agent when --agent is used without a value
default.base_imagestringDefault container base image
default.multiplexerstringDefault terminal multiplexer (tmux, zellij)
storage.worktreesstringDirectory for git worktrees
storage.catalogstringPath to the instance catalog file
storage.logsstringDirectory for session logs
runtime.namestringContainer runtime (podman, apple)

Configuration File

The configuration file is located at ~/.config/headjack/config.yaml. If the file does not exist, it is created with default values when you first run hjk config.

Editor Mode

The --edit flag opens the configuration file in your preferred editor as specified by the $EDITOR environment variable. If $EDITOR is not set, the command returns an error.

Output Format

  • String values are printed directly
  • Complex values (maps, arrays) are printed as YAML

See Also

  • hjk run - Uses default.agent and default.base_image
  • hjk auth - Configure agent authentication