README
¶
chalk
Task-oriented I/O helper for Golang CLI. It wires together flag-driven input/output routing (local filesystem, S3, stdin/stdout) with a live terminal progress UI so you can focus on the processing logic.
Features
- Resolves input from a local directory (
-I ./path), an S3 bucket (-I s3://bucket), explicit file arguments, or stdin - Resolves output to a local directory (
-O ./path), an S3 bucket (-O s3://bucket), a single file (-o out.txt), or stdout - Renders a live progress tree with elapsed timers, spinner, and per-task pass/fail status
Quick Start
package main
import (
"context"
"github.com/fogfish/chalk"
)
func process(ctx context.Context, path string, r io.Reader, w io.Writer) error {
chalk.Task(path)
chalk.SubTask("read")
// ... read from fs
chalk.SubDone()
chalk.SubTask("transform")
// ... do work
chalk.SubDone()
chalk.Done()
return nil
}
func main() {
chalk.Start(process)
}
Run it:
mytool -I ./input -O ./output
mytool -I s3://my-bucket -O s3://out-bucket
cat file.txt | mytool
License
See LICENSE.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Panic ¶
func Panic(err error)
Panic prints a fatal error, fails all pending tasks, and exits with code 1.
func Printf ¶ added in v0.0.4
Printf prints a formatted, multi-line message indented under the current task.
Types ¶
type Reporter ¶
type Reporter struct {
// contains filtered or unexported fields
}
Reporter manages classical terminal output with a live spinner for the active task and a scrolling history of completed / failed tasks above it.
func NewReporter ¶
func NewReporter() *Reporter
NewReporter creates a Reporter that writes to stderr.
func (*Reporter) Done ¶
func (r *Reporter) Done()
Done marks the current (innermost) task as successfully completed.
func (*Reporter) Fail ¶
Fail marks the current (innermost) task as failed. err is printed as an indented paragraph beneath the task line.
func (*Reporter) Printf ¶ added in v0.0.4
Printf prints a formatted, multi-line message indented one level deeper than the current task. The spinner is stopped for the duration of the write and restarted afterwards so the output line does not get overwritten.
func (*Reporter) Quit ¶
func (r *Reporter) Quit()
Quit stops the spinner and marks all remaining tasks as done. Call this when all work has been completed.
Source Files
Directories