Shresht7 / go-cli-tools

Command-line tools and utilities for Go

go-cli-tools

Command-line tools and utilities for Go projects.

Table of Contents

• go-cli-tools
  • 📦 ANSI Modules
    • 🎨 Colors
    • 💄 Styles
    • ☝ Cursor
    • 🧼 Clear
    • 🅰 RegExp
  • 📚 Helpers
    • 🏭 Composition
  • 📃 Format
    • Align
    • HereDoc
    • Pad
  • ✔ Symbols
  • ✔ Status
  • 📑 License

---

📦 ANSI Modules

🎨 Colors

The colors package allows you to style text with colors.

import "github.com/Shresht7/go-cli-tools/ansi/colors"

fmt.Println(colors.Red("Giant"))
fmt.Println(colors.BgWhite("Dwarf"))
fmt.Println(colors.RGB("Supernova", 224, 65, 137))

⬆ Back to Top

💄 Styles

The styles package allows you to format your text.

import "github.com/Shresht7/go-cli-tools/ansi/styles"

fmt.Println(styles.Bold("GO"))
fmt.Println(styles.Hidden("Secret"))

⬆ Back to Top

☝ Cursor

The cursor package provides helper function for cursor manipulation.

import "github.com/Shresht7/go-cli-tools/ansi/cursor"

fmt.Print(cursor.ToPos(15, 20))
fmt.Print(cursor.Up(3))
fmt.Print(cursor.ToNextLine(5))

⬆ Back to Top

🧼 Clear

The clear package provides helper functions to clear the terminal.

import "github.com/Shresht7/go-cli-tools/ansi/clear"

fmt.Println(clear.EntireLine)
fmt.Println(clear.Screen)

⬆ Back to Top

🅰 RegExp

Regular expressions to capture ansi codes. The Strip helper function can remove all ansi escape codes from a string.

import "github.com/Shresht7/go-cli-tools/ansi/codes"

var text string = "..."
text = codes.Strip(text)
fmt.Println(text)

⬆ Back to Top

---

📚 Helpers

🏭 Composition

Composition helpers provide two utility functions compose and pipe that allow you to combine many ansi functions together.

import "github.com/Shresht7/go-cli-tools/helpers"
import "github.com/Shresht7/go-cli-tools/ansi/colors"
import "github.com/Shresht7/go-cli-tools/ansi/styles"

styler = helpers.Compose(colors.Blue, styles.Bold, colors.BgWhite)
text = styler("Function Composition!")

⬆ Back to Top

---

📃 Format

Align

Align text to the left, center or right.

import "github.com/Shresht7/go-cli-tools/format"
var text string = "..."
fmt.Println(format.Align(text, &format.AlignOptions{ Mode: "Center" }))

⬆ Back to Top

HereDoc

HereDoc is a helper function to create a multi-line string.

import "github.com/Shresht7/go-cli-tools/format"
var text string = format.HereDoc(`
    This is a multi-line string
    that can be used to create
      a template.
`)
// Output:
// This is a multi-line string
// that can be used to create
//  a template.

⬆ Back to Top

Pad

Apply padding around the text.

import "github.com/Shresht7/go-cli-tools/format"
var text string = "..."
fmt.Println(format.Pad(text, " ", 5))

⬆ Back to Top

---

✔ Symbols

Unicode symbols for the terminal

✔ ℹ ⚠ ✖ ☰ ↑ ↓ ← → ♪ ♫ ■ ● ․ … › ▲ ▴ ▼ ▾ ◂ ▸ ⌂ ♥ ↔ ↕ ≈ ≠ ≤ ≥ ≡ ∞ ෴ ★ ▶ ⬢

import "github.com/Shresht7/go-cli-tools/symbols"

fmt.Println(symbols.Warning, "Are you sure?")
//  ⚠ Are you sure?

fmt.Println(symbols.Tick, "Done")
//  ✔ Done

fmt.Println("Controls: ", symbols.ArrowUp, symbols.ArrowDown, symbol.ArrowLeft, symbols.ArrowRight)
//  Controls: ↑ ↓ ← →

⬆ Back to Top

✔ Status

The status package includes some commonly used symbols with color.

import "github.com/Shresht7/go-cli-tools/status"

fmt.Println(status.Tick, "Done")  //  ✔ Done

⬆ Back to Top

---

📑 License

This project is licensed under the MIT License - see the LICENSE file for details.