Back to Home
CLI Commands

gk plan

Create and manage execution plans

Overview

The gk plan command manages project plans with subcommands for listing, creating, setting active plans, and viewing status.

Usage

bash
gk plan [subcommand] [name] [options]

Alias: gk p

Subcommands

list (default)

Displays all available plans.

bash
gk plan list
gk plan  # same as above

Output:

  • Plan names with creation dates
  • Active plan marked with indicator

Returns empty message if no plans exist.

status

Shows the currently active plan.

bash
gk plan status

Displays active plan name or indicates none is set.

create

Creates a new plan.

bash
gk plan create <name>

Required: Plan name

The new plan is automatically set as active after creation.

Output: Confirms creation with file path and session info.

set

Designates an existing plan as active.

bash
gk plan set <name>

Required: Plan name

Verifies plan exists before setting. Updates both session and .env file.

info

Retrieves plan configuration from .env file.

bash
gk plan info
gk plan info -a  # active plan only
gk plan info -s  # suggested plan only
gk plan info -f  # date format only

Options:

  • -a, --active - Shows only ACTIVE_PLAN value
  • -s, --suggested - Shows only SUGGESTED_PLAN value
  • -f, --format - Shows only PLAN_DATE_FORMAT value

Default shows all plan settings with session context.

Global Options

OptionDescription
--jsonOutput in JSON format (all subcommands)

Examples

bash
# List all plans
gk plan list

# Check current active plan
gk plan status

# Create a new plan
gk plan create authentication-feature

# Set an existing plan as active
gk plan set user-dashboard

# Get plan info
gk plan info

# Get only active plan name
gk plan info --active

# Output as JSON
gk plan list --json
gk plan status --json

Plan Naming

Plans follow the naming format configured in .gk.json:

json
{
  "plan": {
    "namingFormat": "{date}-{issue}-{slug}",
    "dateFormat": "YYMMDD-HHmm",
    "issuePrefix": "GH-"
  }
}
Caught a mistake? Edit this page on GitHub
Updated: Jan 20, 2026