templates

Themes and Templates

This folder contains sample templates to customize madonctl output.

Feel free to contribute if you have nice templates or if you want to work on themes as well!

Configuration

The template prefix directory can be set in the configuration file with the 'template_directory' setting, or with the MADONCTL_TEMPLATE_DIRECTORY environment variable.
If set, template files are looked up relatively from this repository first (unless they are absolute paths or start with "./" or "../").

The themes are located in the themes directory, inside the base template directory (e.g. $template_directory/themes/ansi/). A theme is a collection of templates grouped in a theme directory (the name of the directory is the name of the theme).

Themes

To use a theme, simply specify the theme name with the --theme flag (the --output=theme flag is implied):

madonctl timeline --limit=2 --theme=ansi
madonctl accounts statuses --limit 5 --theme ansi

madonctl --theme=ansi accounts notifications --list
madonctl --theme=ansi stream

Currently, if a template is missing, madonctl will fall back to the plain output format. (In the future it might just fail with an error message.)

You can set up madonctl so that a theme is used by default. See the configuration page for details.

Templates

Here's an example using a template with ANSI color escape codes (for UNIX/Linux):

madonctl timeline --limit 2 --template-file ansi-status.tmpl

Template development

Here's a list of available commands (please check the Go template documentation for the built-in functions):

Function	Description
fromunix UNIXTIMESTAMP	converts from UNIX timestamp to date
tolocal TEXTRFC3339DATE	converts a RFC3339 date string to a local time
fromhtml HTMLTEXT	converts HTML to plain text
wrap TEXT	rewrap text, with indent and max width
trim TEXT	trims text whitespace
color COLORSPEC	sends an ANSI color code sequence

COLORSPEC is a string with the following format: [FGCOLOR][,BGCOLOR[,STYLE]] or reset.

Examples:

  {{color "red"}}red text{{color "reset"}}
  {{color ",red"}}red background{{color "reset"}}
  {{color "white,,bold"}}bright white text{{color "reset"}}

  Message: {{color "blue"}}{{.content | fromhtml | wrap "    " 80 | trim}}{{color "reset"}}