Skip to content

Interactive Mode ​

Learn how to use spectryn's interactive mode for step-by-step guided syncing.

Duration: ~3 minutes

🎮

Interactive Session Recording

When to Use Interactive Mode ​

Interactive mode is perfect when you want to:

  • Review each change before applying
  • Skip specific stories that aren't ready
  • Sync selectively during development
  • Learn what spectryn does step-by-step

Starting Interactive Mode ​

bash
$ spectryn --markdown EPIC.md --epic PROJ-123 --interactive

╭──────────────────────────────────────────────────────────────╮
│  spectryn v1.0.0 - Interactive Mode                           │
│  Syncing: EPIC.md → PROJ-123                                 │
╰──────────────────────────────────────────────────────────────╯

📋 Found 3 stories to sync

Press Enter to continue or 'q' to quit...

Story-by-Story Review ​

Story 1: Preview Changes ​

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Story 1 of 3
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

📖 US-001: User Authentication
   Jira Issue: PROJ-124
   Story Points: 5
   Status: Planned → In Progress

┌─────────────────────────────────────────────────────────────┐
│ Changes to apply:                                           │
├─────────────────────────────────────────────────────────────┤
│ 📝 Update description                                       │
│    Current: "Implement user login"                          │
│    New: "As a user, I want to authenticate securely..."     │
│                                                             │
│ ➕ Create 3 subtasks:                                       │
│    1. Create login form (2 SP)                              │
│    2. Implement JWT auth (2 SP)                             │
│    3. Add password reset (1 SP)                             │
│                                                             │
│ 🔄 Transition status:                                       │
│    Open → In Progress                                       │
└─────────────────────────────────────────────────────────────┘

Apply changes to US-001? [y]es / [n]o / [s]kip / [q]uit: █

Applying Changes ​

Apply changes to US-001? [y]es / [n]o / [s]kip / [q]uit: y

Applying changes to PROJ-124...
  ✓ Updated description
  ✓ Created subtask PROJ-125: Create login form
  ✓ Created subtask PROJ-126: Implement JWT auth
  ✓ Created subtask PROJ-127: Add password reset
  ✓ Transitioned to In Progress

✅ Story synced successfully!

Press Enter to continue to next story...

Skipping a Story ​

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Story 2 of 3
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

📖 US-002: User Registration
   Jira Issue: PROJ-128
   Story Points: 5
   Status: Planned (no change)

┌─────────────────────────────────────────────────────────────┐
│ Changes to apply:                                           │
├─────────────────────────────────────────────────────────────┤
│ 📝 Update description                                       │
│ ➕ Create 4 subtasks                                        │
└─────────────────────────────────────────────────────────────┘

Apply changes to US-002? [y]es / [n]o / [s]kip / [q]uit: s

⏭️  Skipped US-002

Press Enter to continue to next story...

Viewing Diff ​

Press d to see a detailed diff:

Apply changes to US-003? [y]es / [n]o / [s]kip / [d]iff / [q]uit: d

┌─────────────────────────────────────────────────────────────┐
│ Description Diff                                            │
├─────────────────────────────────────────────────────────────┤
│ - Implement password reset functionality                    │
│ + **As a** user who forgot their password                   │
│ + **I want** to reset it via email                          │
│ + **So that** I can regain access to my account             │
│ +                                                           │
│ + The reset link should expire after 1 hour.                │
└─────────────────────────────────────────────────────────────┘

Apply changes to US-003? [y]es / [n]o / [s]kip / [d]iff / [q]uit: █

Session Summary ​

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Interactive Session Complete
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

╭──────────────────────────────────────────────────────────────╮
│  📊 Summary                                                  │
│                                                              │
│  Stories processed: 3                                        │
│  ├── Applied: 2                                              │
│  ├── Skipped: 1                                              │
│  └── Failed: 0                                               │
│                                                              │
│  Subtasks created: 6                                         │
│  Descriptions updated: 2                                     │
│  Status transitions: 1                                       │
│                                                              │
│  Duration: 45s                                               │
│  Backup: backup_20250113_144500                              │
╰──────────────────────────────────────────────────────────────╯

Skipped stories can be synced later with:
  spectryn --markdown EPIC.md --epic PROJ-123 --story US-002

Interactive Mode Commands ​

KeyAction
yApply changes to this story
nDon't apply (same as skip)
sSkip this story
dShow detailed diff
qQuit interactive mode
?Show help

Tips ​

When to Skip

Skip stories that:

  • Are still being refined
  • Have dependencies not yet ready
  • Need discussion before syncing

Resume Later

Skipped stories can be synced individually:

bash
spectryn -m EPIC.md -e PROJ-123 --story US-002 -x

What's Next? ​

Released under the MIT License.