Skip to main content

hjk run

Create a new session within an instance for a specified branch.

Synopsis​

hjk run <branch> [prompt] [flags]

Description​

Creates a new session within an instance for the specified branch. If no instance exists for the branch, one is created first by:

  • Creating a git worktree at the configured location
  • Spawning a new container with the worktree mounted

A new session is always created within the instance. If --agent is specified, the agent is started with an optional prompt. Otherwise, the default shell is started.

Unless --detached is specified, the terminal attaches to the session. All session output is captured to a log file regardless of attached/detached mode.

If an instance exists but is stopped, it is automatically restarted before creating the new session.

Arguments​

ArgumentDescription
branchGit branch name for the instance (required)
promptInstructions to pass to the agent (optional, only used with --agent)

Flags​

FlagShortTypeDefaultDescription
--agentstringStart the specified agent instead of a shell. Valid values: claude, gemini, codex. If specified without a value, uses the configured default.agent.
--namestringOverride the auto-generated session name
--basestringOverride the default base image
--detached-dboolfalseCreate session but do not attach (run in background)

Examples​

# Create instance with shell session
hjk run feat/auth

# Create instance with Claude agent
hjk run feat/auth --agent claude "Implement JWT authentication"

# Create additional session in existing instance
hjk run feat/auth --agent gemini --name gemini-experiment

# Create shell session with custom name
hjk run feat/auth --name debug-shell

# Create detached sessions (run in background)
hjk run feat/auth --agent claude -d "Refactor the auth module"
hjk run feat/auth --agent claude -d "Write tests for auth module"

# Use a custom base image
hjk run feat/auth --base my-registry.io/custom-image:latest

# Use default agent from config
hjk run feat/auth --agent

Authentication​

When using an agent, the command requires authentication to be configured first:

  • Claude: Run hjk auth claude first
  • Gemini: Run hjk auth gemini first
  • Codex: Run hjk auth codex first

Authentication tokens are automatically injected into the container environment.

See Also​