📋 Add user-friendly tasks to your terminal

Tip

All output is Github Action friendly! You can view the output of each example here

Installation

go get github.com/fumeapp/taskin

Examples

Simplest way to line up and fire off tasks

taskin/examples/simple/main.go

Lines 11 to 33 in 3cd766c

	tasks:=taskin.New(taskin.Tasks{
	{
	Title: "Task 1",
	Task: func(t*taskin.Task) error {
	fori:=0; i<3; i++ {
	t.Title=fmt.Sprintf("Task 1: [%d/3] seconds have passed", i+1)
	time.Sleep(500*time.Millisecond)
	}
	returnnil
	},
	},
	{
	Title: "Task 2",
	Task: func(t*taskin.Task) error {
	fori:=0; i<3; i++ {
	t.Title=fmt.Sprintf("Task 2: [%d/3] seconds have passed", i+1)
	time.Sleep(500*time.Millisecond)
	}
	returnfmt.Errorf("task 2 failed")
	},
	},
	}, taskin.Defaults)
	err:=tasks.Run()

Using a progress bar for a task

taskin/examples/progress/main.go

Lines 11 to 24 in 06b4d11

	tasks:=taskin.New(taskin.Tasks{
	{
	Title: "Progress",
	Task: func(t*taskin.Task) error {
	fori:=0; i<5; i++ {
	t.Progress(i+1, 5)
	t.Title=fmt.Sprintf("Progress [%d/%d]", i+1, 5)
	time.Sleep(1*time.Second)
	}
	returnnil
	},
	},
	}, taskin.Defaults)
	err:=tasks.Run()

Customize colors, spinner, and progress bar

taskin/examples/custom/main.go

Lines 13 to 54 in 3cd766c

	tasks:=taskin.New(taskin.Tasks{
	{
	Title: "Task 1",
	// sleep for 3 seconds then return nil
	Task: func(t*taskin.Task) error {
	fori:=0; i<2; i++ {
	t.Title=fmt.Sprintf("Task 1 - [%d/%d]", i+1, 2)
	time.Sleep(1*time.Second)
	}
	returnnil
	},
	},
	{
	Title: "Task 2 Progress",
	// sleep for 3 seconds then return nil
	Task: func(t*taskin.Task) error {
	fori:=0; i<5; i++ {
	t.Progress(i+1, 5)
	t.Title=fmt.Sprintf("Task 2 - [%d/%d]", i+1, 5)
	time.Sleep(1*time.Second)
	}
	returnnil
	},
	},
	{
	Title: "Task 3",
	// sleep for 3 seconds then return nil
	Task: func(t*taskin.Task) error {
	fori:=0; i<2; i++ {
	t.Title=fmt.Sprintf("Task 3 - [%d/%d]", i+1, 2)
	time.Sleep(1*time.Second)
	}
	returnnil
	},
	},
	}, taskin.Config{
	Spinner: spinner.Moon,
	ProgressOptions: []progress.Option{
	progress.WithScaledGradient("#6667AB", "#34D399"),
	},
	})
	err:=tasks.Run()

Disable UI animations and spinners

taskin/examples/disable-ui/main.go

Lines 49 to 57 in 4a1b680

	// Create configuration with UI disabled
	cfg:=taskin.Defaults
	cfg.DisableUI=true
	runners:=taskin.New(tasks, cfg)
	err:=runners.Run()
	iferr!=nil {
	panic(err)
	}

This is useful when you want plain text output without animations, similar to CI mode but controllable via configuration.

Nest tasks inside tasks

taskin/examples/multi/main.go

Lines 23 to 34 in 3cd766c

	Title: "Pluck the Chickens",
	Tasks: taskin.Tasks{
	{
	Title: "Pluck the silkies",
	Task: func(t*taskin.Task) error {
	fori:=0; i<3; i++ {
	t.Title=fmt.Sprintf(" [%d/3] silkies plucked", i+1)
	time.Sleep(500*time.Millisecond)
	}
	returnnil
	},
	},

Usage inside a task

The *taskin.Task struct passeed into your task has some useful properties that you can use to customize the task view.

Change the title

Already demonstrated in most of the examples, you can change t.Title at any time

Hide a view

Sometimes you might need to temporarily hide you task view in order to prompt a user for input. You can do this by toggling the task.HideView boolean.

Task: func(T*taskin.Task ) error {
t.HideView=trueiferr:=PromptForInput(); err!=nil {
t.HideView=falsereturnerr
}
t.HideView=falset.Title="Input received"returnnil
}