feat: add interactive TUI for task execution

Taskfile.tui-tests.yml

@@ -0,0 +1,142 @@
+version: '3'
+
+tasks:
+  shared-dep-always-running:
+    desc: Two parents call a shared dependency with the default run behavior
+    deps: [parent-a-always, parent-b-always]
+
+  parent-a-always:
+    internal: true
+    deps: [shared-always]
+    cmds:
+      - echo "parent A continued after shared-always"
+
+  parent-b-always:
+    internal: true
+    deps: [shared-always]
+    cmds:
+      - echo "parent B continued after shared-always"
+
+  shared-always:
+    internal: true
+    silent: true
+    cmds:
+      - |
+        echo "shared-always START $(date +%H:%M:%S.%3N)"
+        sleep 2
+        echo "shared-always END   $(date +%H:%M:%S.%3N)"
+
+  shared-dep-running-once:
+    desc: Two parents call a shared dependency configured with run once
+    deps: [parent-a-once, parent-b-once]
+
+  parent-a-once:
+    internal: true
+    deps: [shared-once]
+    cmds:
+      - echo "parent A continued after shared-once"
+
+  parent-b-once:
+    internal: true
+    deps: [shared-once]
+    cmds:
+      - echo "parent B continued after shared-once"
+
+  shared-once:
+    internal: true
+    run: once
+    silent: true
+    cmds:
+      - |
+        echo "shared-once START $(date +%H:%M:%S.%3N)"
+        sleep 2
+        echo "shared-once END   $(date +%H:%M:%S.%3N)"
+
+  fail-fast-example:
+    desc: One task succeeds, one fails, and one is canceled by fail-fast
+    failfast: true
+    deps:
+      - success-after-1s
+      - fail-after-2s
+      - success-after-3s
+
+  success-after-1s:
+    internal: true
+    cmds:
+      - echo "1-second task START"
+      - sleep 1
+      - echo "1-second task SUCCESS"
+
+  fail-after-2s:
+    internal: true
+    cmds:
+      - echo "2-second task START"
+      - sleep 2
+      - echo "2-second task FAILING"
+      - exit 1
+
+  success-after-3s:
+    internal: true
+    cmds:
+      - echo "3-second task START"
+      - sleep 3
+      - echo "3-second task SUCCESS"
+
+  unresolvable-dep-example:
+    desc: A dep that does not exist still appears, with its own error
+    deps:
+      - compiles-fine
+      - typoo
+
+  compiles-fine:
+    internal: true
+    cmds:
+      - echo "this one resolves and runs"
+
+  skipped-deps-example:
+    desc: Deps skipped by platform and by an if condition, next to one that runs
+    deps:
+      - other-platform-only
+      - condition-not-met
+      - condition-met
+
+  other-platform-only:
+    internal: true
+    platforms: [plan9]
+    cmds:
+      - echo "never runs on a normal machine"
+
+  condition-not-met:
+    internal: true
+    if: 'false'
+    cmds:
+      - echo "never runs"
+
+  condition-met:
+    internal: true
+    if: 'true'
+    cmds:
+      - echo "the if condition was met, so this ran"
+
+  labelled-task-example:
+    desc: A dep announced by its Taskfile name, then renamed to its label
+    deps:
+      - docs
+
+  docs:
+    internal: true
+    label: Build the docs
+    cmds:
+      - echo "renamed once compilation resolved the label"
+
+  progress-bar-example:
+    desc: A progress bar that redraws one line, next to ordinary line output
+    cmds:
+      - |
+        echo "starting download"
+        for i in $(seq 0 5 100); do
+          printf "\rDownloading... %3d%%" "$i"
+          sleep 0.15
+        done
+        printf "\rDownloading... done   \n"
+        echo "finished"

call.go

@@ -8,4 +8,8 @@ type Call struct {
 	Vars     *ast.Vars
 	Silent   bool
 	Indirect bool // True if the task was called by another task
+
+	invocationID       uint64
+	parentInvocationID uint64
+	rootInvocationID   uint64
 }

cmd/task/task.go

@@ -16,6 +16,7 @@ import (
 	"github.com/go-task/task/v3/internal/filepathext"
 	"github.com/go-task/task/v3/internal/flags"
 	"github.com/go-task/task/v3/internal/logger"
+	"github.com/go-task/task/v3/internal/tui"
 	"github.com/go-task/task/v3/internal/version"
 	"github.com/go-task/task/v3/taskfile/ast"
 )
@@ -168,7 +169,7 @@ func run() error {
 	calls, globals := args.Parse(cliArgsPreDash...)
 
 	// If there are no calls, run the default task instead
-	if len(calls) == 0 {
+	if len(calls) == 0 && !flags.TUI {
 		calls = append(calls, &task.Call{Task: "default"})
 	}
 
@@ -198,6 +199,16 @@ func run() error {
 	if flags.Status {
 		return e.Status(ctx, calls...)
 	}
+	if flags.TUI {
+		ui, err := tui.New(e.Logger, tui.Options{
+			Status:        flags.TUIStatus,
+			TaskNavigator: flags.TUITaskNavigator,
+		})
+		if err != nil {
+			return err
+		}
+		return ui.Run(ctx, e, calls)
+	}
 
 	return e.Run(ctx, calls...)
 }

executor.go

@@ -68,6 +68,7 @@ type (
 		Compiler           *Compiler
 		Output             output.Output
 		OutputStyle        ast.Output
+		Listener           Listener // Optional; observes execution and may own the terminal
 		TaskSorter         sort.Sorter
 		UserWorkingDir     string
 		EnableVersionCheck bool
@@ -81,6 +82,7 @@ type (
 		mkdirMutexMap        map[string]*sync.Mutex
 		executionHashes      map[string]*executionState
 		executionHashesMutex sync.Mutex
+		taskInvocationID     uint64
 		watchedDirs          *xsync.Map[string, bool]
 	}
 	TempDir struct {

go.mod

@@ -10,6 +10,7 @@ require (
 	github.com/Masterminds/semver/v3 v3.5.0
 	github.com/alecthomas/chroma/v2 v2.27.0
 	github.com/chainguard-dev/git-urls v1.0.2
+	github.com/charmbracelet/x/ansi v0.11.8
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc
 	github.com/dominikbraun/graph v0.23.0
 	github.com/elliotchance/orderedmap/v3 v3.1.1
@@ -69,7 +70,6 @@ require (
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/charmbracelet/colorprofile v0.4.3 // indirect
 	github.com/charmbracelet/ultraviolet v0.0.0-20260811164956-006e29f97886 // indirect
-	github.com/charmbracelet/x/ansi v0.11.8 // indirect
 	github.com/charmbracelet/x/term v0.2.2 // indirect
 	github.com/charmbracelet/x/termios v0.1.1 // indirect
 	github.com/charmbracelet/x/windows v0.2.2 // indirect

internal/flags/flags.go

@@ -70,6 +70,9 @@ var (
 	Concurrency         int
 	Dir                 string
 	Entrypoint          string
+	TUI                 bool
+	TUIStatus           string
+	TUITaskNavigator    string
 	Output              ast.Output
 	Color               bool
 	Interval            time.Duration
@@ -144,6 +147,9 @@ func init() {
 	pflag.BoolVarP(&ExitCode, "exit-code", "x", false, "Pass-through the exit code of the task command.")
 	pflag.StringVarP(&Dir, "dir", "d", "", "Sets the directory in which Task will execute and look for a Taskfile.")
 	pflag.StringVarP(&Entrypoint, "taskfile", "t", "", `Choose which Taskfile to run. Defaults to "Taskfile.yml".`)
+	pflag.BoolVarP(&TUI, "tui", "T", false, "Runs Task in an interactive terminal interface.")
+	pflag.StringVar(&TUIStatus, "tui-status", "", "Sets TUI task status style: [icons|labels].")
+	pflag.StringVar(&TUITaskNavigator, "tui-task-navigator", "", "Sets TUI task navigator: [list|tree]. Defaults to tree.")
 	pflag.StringVar(&TempDir, "temp-dir", getConfig(config, "TEMP_DIR", func() *string { return config.TempDir }, ""), "Sets the directory used to store Task temporary files, such as checksums. Relative paths are relative to the root Taskfile.")
 	pflag.StringVarP(&Output.Name, "output", "o", getConfig(config, "OUTPUT", func() *string { return nil }, ""), "Sets output style: [interleaved|group|prefixed].")
 	pflag.StringVar(&Output.Group.Begin, "output-group-begin", getConfig(config, "OUTPUT_GROUP_BEGIN", func() *string { return nil }, ""), "Message template to print before a task's grouped output.")
@@ -213,16 +219,14 @@ func Validate() error {
 		return errors.New("task: You can't set both --global and --dir")
 	}
 
-	if Output.Name != "group" {
-		if Output.Group.Begin != "" {
-			return errors.New("task: You can't set --output-group-begin without --output=group")
-		}
-		if Output.Group.End != "" {
-			return errors.New("task: You can't set --output-group-end without --output=group")
-		}
-		if Output.Group.ErrorOnly {
-			return errors.New("task: You can't set --output-group-error-only without --output=group")
-		}
+	if err := validateOutputOptions(Output); err != nil {
+		return err
+	}
+	if err := validateTUIOptions(TUI, TUIStatus, TUITaskNavigator); err != nil {
+		return err
+	}
+	if TUI && (List || ListAll || ListJson || Status || Summary || Watch || Interactive) {
+		return errors.New("task: --tui cannot be combined with task listing, status, summary, watch, or interactive modes")
 	}
 
 	if List && ListAll {
@@ -249,6 +253,34 @@ func Validate() error {
 	return nil
 }
 
+func validateOutputOptions(output ast.Output) error {
+	if output.Name != "group" {
+		if output.Group.Begin != "" {
+			return errors.New("task: You can't set --output-group-begin without --output=group")
+		}
+		if output.Group.End != "" {
+			return errors.New("task: You can't set --output-group-end without --output=group")
+		}
+		if output.Group.ErrorOnly {
+			return errors.New("task: You can't set --output-group-error-only without --output=group")
+		}
+	}
+	return nil
+}
+
+func validateTUIOptions(enabled bool, status, navigator string) error {
+	if enabled {
+		return nil
+	}
+	if status != "" {
+		return errors.New("task: You can't set --tui-status without --tui")
+	}
+	if navigator != "" {
+		return errors.New("task: You can't set --tui-task-navigator without --tui")
+	}
+	return nil
+}
+
 // WithFlags is a special internal functional option that is used to pass flags
 // from the CLI into any constructor that accepts functional options.
 func WithFlags() task.ExecutorOption {

internal/flags/flags_test.go

@@ -0,0 +1,75 @@
+package flags
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/go-task/task/v3/taskfile/ast"
+)
+
+func TestValidateOutputOptions(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		name      string
+		output    ast.Output
+		wantError string
+	}{
+		{
+			name:   "group options with group output",
+			output: ast.Output{Name: "group", Group: ast.OutputGroup{Begin: "begin", End: "end", ErrorOnly: true}},
+		},
+		{
+			name:      "group option without group output",
+			output:    ast.Output{Name: "interleaved", Group: ast.OutputGroup{Begin: "begin"}},
+			wantError: "--output-group-begin without --output=group",
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			t.Parallel()
+
+			err := validateOutputOptions(test.output)
+			if test.wantError == "" {
+				require.NoError(t, err)
+				return
+			}
+			require.Error(t, err)
+			assert.Contains(t, err.Error(), test.wantError)
+		})
+	}
+}
+
+func TestValidateTUIOptions(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		name      string
+		enabled   bool
+		status    string
+		navigator string
+		wantError string
+	}{
+		{name: "TUI without options", enabled: true},
+		{name: "TUI with options", enabled: true, status: "labels", navigator: "tree"},
+		{name: "status without TUI", status: "labels", wantError: "--tui-status without --tui"},
+		{name: "navigator without TUI", navigator: "tree", wantError: "--tui-task-navigator without --tui"},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			t.Parallel()
+
+			err := validateTUIOptions(test.enabled, test.status, test.navigator)
+			if test.wantError == "" {
+				require.NoError(t, err)
+				return
+			}
+			require.Error(t, err)
+			assert.Contains(t, err.Error(), test.wantError)
+		})
+	}
+}