Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.macchina.enable

Whether to enable macchina system information fetcher.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.macchina.package

The macchina package to use.

Type: null or package

Default:

pkgs.macchina

Declared by:

programs.macchina.settings.current_shell

Show the current shell rather than the user’s default shell.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.settings.disk_space_percentage

Show percentage next to disk space information.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.settings.disks

Disks to show disk usage for.

Type: null or (list of string)

Default:

null

Example:

[
  "/"
  "/home/user"
]

Declared by:

programs.macchina.settings.interface

Network interface to use for the LocalIP readout. Omitted when null.

Type: null or string

Default:

null

Example:

"wlan0"

Declared by:

programs.macchina.settings.long_kernel

Show lengthened kernel output.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.settings.long_shell

Show lengthened shell output.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.settings.long_uptime

Show lengthened uptime output.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.settings.memory_percentage

Show percentage next to memory information.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.settings.physical_cores

Show physical CPU core count rather than logical core count.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.settings.show

Display only the specified readouts. When null, all readouts are shown. Values are case-sensitive.

Type: null or (list of (one of “Host”, “Machine”, “Kernel”, “Distribution”, “OperatingSystem”, “DesktopEnvironment”, “WindowManager”, “Resolution”, “Backlight”, “Packages”, “LocalIP”, “Terminal”, “Shell”, “Uptime”, “Processor”, “ProcessorLoad”, “Memory”, “Battery”, “GPU”, “DiskSpace”))

Default:

null

Example:

[
  "Battery"
  "Memory"
  "Processor"
  "Shell"
]

Declared by:

programs.macchina.settings.theme

Name of the theme to use, without the .toml extension. Case-sensitive. Must correspond to a file in the macchina themes directory, or be defined in programs.macchina.themes. Omitted when null.

Type: null or string

Default:

null

Example:

"Hydrogen"

Declared by:

programs.macchina.themes

Attribute set of macchina themes. Each entry is written to $XDG_CONFIG_HOME/macchina/themes/<name>.toml.

Theme names are case-sensitive. A theme defined here can be activated by setting programs.macchina.settings.theme to its name.

See https://github.com/Macchina-CLI/macchina/wiki/Customization for details.

Type: attribute set of (submodule)

Default:

{ }

Example:

{
  Hydrogen = {
    bar = {
      glyph = "o";
      hide_delimiters = true;
      symbol_close = "]";
      symbol_open = "[";
      visible = true;
    };
    box = {
      border = "plain";
      inner_margin = {
        x = 1;
        y = 0;
      };
      visible = true;
    };
    hide_ascii = true;
    key_color = "Cyan";
    keys = {
      backlight = "Brightness";
      battery = "Battery";
      cpu = "CPU";
      cpu_load = "CPU Load";
      de = "DE";
      disk_space = "Disk Space";
      distro = "Distro";
      gpu = "GPU";
      host = "Host";
      kernel = "Kernel";
      local_ip = "Local IP";
      machine = "Machine";
      memory = "Memory";
      os = "OS";
      packages = "Packages";
      resolution = "Resolution";
      shell = "Shell";
      terminal = "Terminal";
      uptime = "Uptime";
      wm = "WM";
    };
    padding = 0;
    palette = {
      type = "Full";
      visible = false;
    };
    randomize = {
      key_color = false;
      separator_color = false;
    };
    separator = ">";
    separator_color = "White";
    spacing = 2;
  };
}

Declared by:

programs.macchina.themes.<name>.bar

Bar section. Replaces data ranging from 0–100% with visual bars. Omit to exclude the [bar] section entirely.

Type: null or (submodule)

Default:

null

Declared by:

programs.macchina.themes.<name>.bar.glyph

Glyph to use for all bars.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.bar.hide_delimiters

Whether to hide bar delimiters.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.themes.<name>.bar.symbol_close

Closing delimiter character. Must be a single character.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.bar.symbol_open

Opening delimiter character. Must be a single character.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.bar.visible

Whether to show bars.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.themes.<name>.box

Box section. Renders a box around system information. Omit to exclude the [box] section entirely.

Type: null or (submodule)

Default:

null

Declared by:

programs.macchina.themes.<name>.box.border

Border style for the box.

Type: null or one of “plain”, “thick”, “rounded”, “double”

Default:

null

Declared by:

programs.macchina.themes.<name>.box.inner_margin

Inner margin between content and the box border.

Type: null or (submodule)

Default:

null

Declared by:

programs.macchina.themes.<name>.box.inner_margin.x

Horizontal margin between content and the box border.

Type: null or (unsigned integer, meaning >=0)

Default:

null

Declared by:

programs.macchina.themes.<name>.box.inner_margin.y

Vertical margin between content and the box border.

Type: null or (unsigned integer, meaning >=0)

Default:

null

Declared by:

programs.macchina.themes.<name>.box.title

Title displayed on the box. Omitted from config when null.

Type: null or string

Default:

null

Example:

"Hydrogen"

Declared by:

programs.macchina.themes.<name>.box.visible

Whether to show the box.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.themes.<name>.custom_ascii

Custom ASCII section. Specify your own ASCII art file. Omit to exclude the [custom_ascii] section entirely.

Type: null or (submodule)

Default:

null

Declared by:

programs.macchina.themes.<name>.custom_ascii.color

Color of the ASCII art. Omitted when null. Accepts hex (“#00FF00”), indexed (“046”), or named colors (e.g. “Green”).

Type: null or string

Default:

null

Example:

"Cyan"

Declared by:

programs.macchina.themes.<name>.custom_ascii.path

Path to a file containing ASCII art. ANSI escape sequences are supported.

Type: null or string or absolute path

Default:

null

Example:

"~/ascii/arch_linux"

Declared by:

programs.macchina.themes.<name>.hide_ascii

Whether to disable ASCII rendering entirely.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.themes.<name>.key_color

Color of the keys. Omitted when null. Accepts hex (“#00FF00”), indexed (“046”), or named colors (e.g. “Cyan”).

Type: null or string

Default:

null

Example:

"Cyan"

Declared by:

programs.macchina.themes.<name>.keys

Keys section. Overrides the display label for each readout. Omit to exclude the [keys] section entirely.

Type: null or (submodule)

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.packages

Label for the Packages readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.backlight

Label for the Backlight readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.battery

Label for the Battery readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.cpu

Label for the Processor readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.cpu_load

Label for the ProcessorLoad readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.de

Label for the DesktopEnvironment readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.disk_space

Label for the DiskSpace readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.distro

Label for the Distribution readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.gpu

Label for the GPU readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.host

Label for the Host readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.kernel

Label for the Kernel readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.local_ip

Label for the LocalIP readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.machine

Label for the Machine readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.memory

Label for the Memory readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.os

Label for the OperatingSystem readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.resolution

Label for the Resolution readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.shell

Label for the Shell readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.terminal

Label for the Terminal readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.uptime

Label for the Uptime readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.keys.wm

Label for the WindowManager readout.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.padding

Padding between content and its surroundings.

Type: null or (unsigned integer, meaning >=0)

Default:

null

Declared by:

programs.macchina.themes.<name>.palette

Palette section. Displays the active colorscheme of your terminal emulator. Omit to exclude the [palette] section entirely.

Type: null or (submodule)

Default:

null

Declared by:

programs.macchina.themes.<name>.palette.glyph

Glyph for the palette. Append a trailing space to separate glyphs.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.palette.spacing

The amount of spacing to leave between each glyph.

Type: null or signed integer

Default:

null

Declared by:

programs.macchina.themes.<name>.palette.type

Color set to use for the palette. Case-sensitive.

Type: null or one of “Dark”, “Light”, “Full”

Default:

null

Declared by:

programs.macchina.themes.<name>.palette.visible

Whether to show the palette.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.themes.<name>.prefer_small_ascii

Always use smaller variants of built-in ASCII art.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.themes.<name>.randomize

Randomize section. Controls random color selection for keys and separators. Omit to exclude the [randomize] section entirely.

Type: null or (submodule)

Default:

null

Declared by:

programs.macchina.themes.<name>.randomize.key_color

Whether to randomize the key color.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.themes.<name>.randomize.pool

Pool of colors to draw from when randomizing. Omitted when null.

  • “hexadecimal”: random color #000000–#FFFFFF
  • “indexed”: random color 0–255
  • “base”: random from black, white, red, green, blue, yellow, magenta, cyan

Type: null or one of “hexadecimal”, “indexed”, “base”

Default:

null

Declared by:

programs.macchina.themes.<name>.randomize.separator_color

Whether to randomize the separator color.

Type: null or boolean

Default:

null

Declared by:

programs.macchina.themes.<name>.separator

Glyph to use as the separator.

Type: null or string

Default:

null

Declared by:

programs.macchina.themes.<name>.separator_color

Color of the separator. Omitted when null. Accepts hex (“#00FF00”), indexed (“046”), or named colors (e.g. “White”).

Type: null or string

Default:

null

Example:

"White"

Declared by:

programs.macchina.themes.<name>.spacing

Spacing between the separator and adjacent content.

Type: null or (unsigned integer, meaning >=0)

Default:

null

Declared by: