liamg / tml

:rainbow::computer::art: A tiny markup language for terminal output. Makes formatting output in CLI apps easier!

tml - Terminal Markup Language

A Go module (and standalone binary) to make the output of coloured/formatted text in the terminal easier and more readable.

You can use it in your Go programs, and bash etc. too.

Usage in Go

The output of coloured/formatted text is easy using the following syntax:

package main

import "github.com/liamg/tml"

func main() {
    tml.Printf("<red>this text is <bold>red</bold></red> and the following is <green>%s</green>\n", "not red")
}

Usage in Bash

First, install tml:

Install Go and run the following command.

# For Go 1.16+
# Make sure that `$GOPATH/bin` is in your `$PATH`, because that's where this gets installed

go install github.com/liamg/tml/tml@latest

# For Go <1.16

go get -u github.com/liamg/tml/tml

Then you can simply pipe text containing tags to tml:

#!/bin/bash

echo "<red>this text is <bold>red</bold></red> and the following is <green>not red</green>" | tml

Format

Each tag is enclosed in angle brackets, much like HTML.

You can nest tags as deeply as you like.

It's not required to close tags you've opened, though it can make for easier reading.

Available Tags

Foreground Colours

• <red>
• <green>
• <yellow>
• <blue>
• <magenta>
• <cyan>
• <lightgrey>
• <darkgrey>
• <black>
• <white>
• <lightred>
• <lightgreen>
• <lightyellow>
• <lightblue>
• <lightmagenta>
• <lightcyan>

Background Colours

• <bg-red>
• <bg-green>
• <bg-yellow>
• <bg-blue>
• <bg-magenta>
• <bg-cyan>
• <bg-lightgrey>
• <bg-darkgrey>
• <bg-black>
• <bg-white>
• <bg-lightred>
• <bg-lightgreen>
• <bg-lightyellow>
• <bg-lightblue>
• <bg-lightmagenta>
• <bg-lightcyan>

Attributes

• <bold>
• <dim>
• <italic>
• <underline>
• <blink>
• <reverse>
• <hidden>

tml's Issues

implement tml in python and want a tml standard document

Hi, thank you for creating the tml, it works really well. I implemented it in python, named tmlpy. I hope to have a tml standard document so that more languages ​​can support it. thanks again for your creation！

Feature request: support PowerShell colours

Like https://github.com/gookit/color does

Release and License

I would like to package tml for void linux, but they do not accept new packages if there is no Release and proper License.

Package availability

My team does a lot of bash scripting as part of our development tools, and TML looks really interesting. We currently have custom echo_<color> commands duplicated across several repositories, and it would be great if we could drop those.

I think the two things that we would need to roll TML out across several repos would be:

• A maintained Homebrew package so our team could locally run brew install tml.
• A maintained Debian package so we could install the tool inside of our Docker images.

Would you be open to adding those things to this repository? We could contribute if that would be helpful.