feat: implement tui command for workflow [CDMD-4526] by amirabbas-gh · Pull Request #1900 · codemod/codemod

amirabbas-gh · 2025-12-16T20:41:47Z

📚 Description

This PR introduces a new interactive Terminal User Interface (TUI) for managing workflow runs in the codemod CLI. The TUI provides a streamlined, step-by-step interface for viewing, monitoring, and managing workflow executions directly from the terminal.

Key Features:

Multi-screen navigation: Navigate through workflow runs → tasks → actions with intuitive keyboard controls
Real-time monitoring: Auto-refresh capabilities to track workflow and task status updates in real-time
Interactive terminal view: Full PTY (pseudo-terminal) support for running tasks with proper color, formatting, and interactive prompts
Task management: View task details, trigger individual tasks or all tasks, and monitor execution progress
Log viewing: Scrollable log viewer with proper terminal emulation (VT100 parser) for accurate rendering
Progress tracking: Visual progress indicators and status messages for workflow and task execution
Confirmation dialogs: Safety prompts for destructive actions like canceling tasks or triggering workflows
Responsive UI: Handles terminal resize events gracefully with proper PTY resizing

Technical Highlights:

Built with ratatui for the TUI framework and crossterm for terminal control
Uses portable-pty for full terminal emulation, enabling proper interactive command execution
Implements VT100 parser for accurate terminal output rendering
Thread-safe state management with proper lock handling and error recovery
Efficient refresh intervals with configurable auto-refresh (default: 1 second)

🧪 Test Plan

Basic TUI Navigation:
```
codemod workflow tui
```
- Verify the workflows list screen appears
- Use arrow keys to navigate through workflow runs
- Press Enter to view tasks for a selected workflow
- Navigate through tasks and view actions screen
- Test keyboard shortcuts (q to quit, h for help, etc.)
Task Triggering:
- Select a workflow and task
- Trigger a single task and verify confirmation dialog
- Trigger all tasks and verify execution
- Monitor task execution in real-time
Terminal View:
- Navigate to terminal view for a running task
- Verify proper terminal emulation (colors, formatting)
- Test interactive prompts if the task requires input
- Verify terminal resize handling
Log Viewing:
- View logs for completed tasks
- Test scrolling through logs (up/down arrows, Page Up/Down)
- Verify log content is properly formatted
Auto-refresh:
- Start a workflow run
- Verify status updates automatically refresh
- Test with custom refresh interval: codemod workflow tui --refresh-interval 5
Error Handling:
- Test with invalid workflow paths
- Verify error messages are displayed properly

vercel · 2025-12-16T20:41:52Z

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment

Project	Deployment	Review	Updated (UTC)
codemod	Ignored		Dec 16, 2025 8:41pm

pkg-pr-new · 2025-12-16T20:43:16Z

Open in StackBlitz

npm i https://pkg.pr.new/codemod@1900

commit: 23dff0f

Copilot

Pull request overview

This PR implements a Terminal User Interface (TUI) command for interactive workflow management. The changes add console log collection capabilities throughout the execution pipeline, introduce a new target_path field to workflow runs, and create a comprehensive TUI with terminal emulation support for monitoring and triggering workflow tasks.

Key changes:

Added target_path field to WorkflowRun model for tracking execution location
Implemented console log collection mechanism across all JavaScript execution engines
Created new TUI command with real-time workflow monitoring and interactive task triggering

Reviewed changes

Copilot reviewed 20 out of 21 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
`crates/models/src/workflow.rs`	Added optional `target_path` field to `WorkflowRun` struct
`crates/core/src/engine.rs`	Added `target_path` parameter to `run_workflow`, enhanced error logging to task logs
`crates/codemod-sandbox/src/sandbox/engine/*.rs`	Added `console_log_collector` callback for capturing JavaScript console output
`crates/codemod-sandbox/Cargo.toml`	Added `gag` dependency for stdout capture
`crates/cli/src/commands/workflow/tui.rs`	New 2500+ line TUI implementation with terminal emulation
`crates/cli/Cargo.toml`	Added TUI dependencies (ratatui, crossterm, portable-pty, vt100)
`crates/core/tests/engine_tests.rs`	Updated all test calls to match new `run_workflow` signature
Various test files	Added `console_log_collector: None` to execution options

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

linear · 2025-12-29T18:02:37Z

CDMD-4526 workflow management tui in codemod cli

sahilmob

LGTM in general; I would prefer we split crates/cli/src/commands/workflow/tui.rs into multiple files. Also, the places where unwrap is used might need some attention.

sahilmob · 2026-01-01T14:04:57Z

crates/cli/src/commands/workflow/tui.rs

+    let pty_system = NativePtySystem::default();
+
+    // Get terminal size from app state
+    let (rows, cols) = app.terminal_size;


Dose this reacts to terminal window size changes

sahilmob · 2026-01-01T14:06:32Z

crates/cli/src/commands/workflow/tui.rs

+
+    // Reset the terminal parser for fresh output
+    {
+        let mut parser = app.terminal_parser.write().unwrap();


What if unwrap fails?

sahilmob · 2026-01-01T14:06:40Z

crates/cli/src/commands/workflow/tui.rs

+
+    // Mark PTY as running
+    {
+        let mut running = app.pty_running.lock().unwrap();


also this one

mohebifar force-pushed the main branch 2 times, most recently from 936b648 to a20d519 Compare December 21, 2025 08:42

amirabbas-gh force-pushed the feat/workflow-tui branch 4 times, most recently from 9c8a7fc to 01dde24 Compare December 25, 2025 18:50

mohebifar requested a review from Copilot December 26, 2025 17:41

Copilot started reviewing on behalf of mohebifar December 26, 2025 17:41 View session

Copilot AI reviewed Dec 26, 2025

View reviewed changes

amirabbas-gh requested a review from mohebifar December 27, 2025 00:22

mohebifar requested a review from sahilmob December 29, 2025 18:02

sahilmob approved these changes Jan 1, 2026

View reviewed changes

amirabbas-gh added 7 commits January 7, 2026 00:48

feat: implement tui command for workflow

715411d

refactor: make treminal and log system

8030b76

refactor: improve user interface

f9d3957

fix: fix the progress bar

c8d2dc6

feat: add allow props

2d0363c

fix: fix format, lint, and failed tests

b996ae8

refactor: improve ui/ux of workflow tui

a8b7d06

amirabbas-gh force-pushed the feat/workflow-tui branch from 571c67f to a8b7d06 Compare January 6, 2026 21:21

refactor: improve resize event and unwrap situation

7c25a70

amirabbas-gh changed the title ~~feat: implement tui command for workflow~~ feat: implement tui command for workflow [CDMD-4526] Jan 6, 2026

refactor: split TUI command code into separate files

806e88c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implement tui command for workflow [CDMD-4526]#1900

feat: implement tui command for workflow [CDMD-4526]#1900
amirabbas-gh wants to merge 9 commits intomainfrom
feat/workflow-tui

amirabbas-gh commented Dec 16, 2025 •

edited

Loading

Uh oh!

vercel bot commented Dec 16, 2025

Uh oh!

pkg-pr-new bot commented Dec 16, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

linear bot commented Dec 29, 2025

Uh oh!

sahilmob left a comment

Uh oh!

sahilmob Jan 1, 2026

Uh oh!

amirabbas-gh Jan 6, 2026

Uh oh!

sahilmob Jan 1, 2026

Uh oh!

amirabbas-gh Jan 6, 2026

Uh oh!

sahilmob Jan 1, 2026

Uh oh!

amirabbas-gh Jan 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

amirabbas-gh commented Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📚 Description

🧪 Test Plan

Uh oh!

vercel bot commented Dec 16, 2025

Uh oh!

pkg-pr-new bot commented Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

linear bot commented Dec 29, 2025

Uh oh!

sahilmob left a comment

Choose a reason for hiding this comment

Uh oh!

sahilmob Jan 1, 2026

Choose a reason for hiding this comment

Uh oh!

amirabbas-gh Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

sahilmob Jan 1, 2026

Choose a reason for hiding this comment

Uh oh!

amirabbas-gh Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

sahilmob Jan 1, 2026

Choose a reason for hiding this comment

Uh oh!

amirabbas-gh Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

amirabbas-gh commented Dec 16, 2025 •

edited

Loading

pkg-pr-new bot commented Dec 16, 2025 •

edited

Loading