Skip to content

LAYOUTS.md

Latest commit

 

History

History
228 lines (174 loc) · 5.45 KB

LAYOUTS.md

File metadata and controls

228 lines (174 loc) · 5.45 KB
Raw

xfetch Layouts

This document explains how to configure and customize layouts in xfetch.

Built-in Layouts

1. Default Layout (Classic)

The default layout displays the logo (ASCII or image) on the left and the system information modules on the right.

Configuration:

To use this layout, simply omit the layout key in your config or set it to null. 

{
    "layout": null,
    // ...
}

2. Side Block Layout

A structured layout where keys and values are displayed in two separate side-by-side boxes.

Configuration:

{
    "layout": "side-block"
}

Appearance:

╭──────────╮ ╭──────────────────────╮
│ User     │ │ jan.rex              │
│ Host     │ │ DIO-LAPTOP           │
╰──────────╯ ╰──────────────────────╯

3. Tree Layout

Displays modules in a hierarchical tree structure. This layout supports grouping modules.

Configuration:

{
    "layout": "tree",
    "modules": [
        {
            "type": "group",
            "title": "OS",
            "modules": ["os", "kernel", "packages"]
        },
        {
            "type": "group",
            "title": "PC",
            "modules": ["cpu", "gpu", "memory"]
        }
    ]
}

Appearance:

 OS
├── os Arch Linux
├── kernel 6.6.1
└── packages 1200 (pacman)
 PC
├── cpu AMD Ryzen 9
└── memory 16 GiB

4. Section Layout

Displays modules in groups with clear section headers.

Configuration:

{
    "layout": "section",
    "modules": [
        {
            "type": "group",
            "title": "Hardware",
            "modules": ["cpu", "gpu", "memory"]
        },
        {
            "type": "group",
            "title": "Software",
            "modules": ["os", "shell"]
        }
    ]
}

Appearance:

────── Hardware ──────
│ cpu: AMD Ryzen 9
│ memory: 16 GiB

────── Software ──────
│ os: Arch Linux

5. Pac-Man Layout

A boxed layout inspired by the Pac-Man game interface.

Configuration:

{
    "layout": "pacman",
    "header_icons": ["ᗧ", "●", "●", "●", "●"], // Icons for top border
    "footer_text": "GAME OVER"                 // Text for bottom border
}

6. Box Layout

Displays the system information enclosed in a simple box with rounded corners.

Configuration:

{
    "layout": "box"
}

7. Line Layout

Displays system information with a horizontal separator line after every 3 modules.

Configuration:

{
    "layout": "line"
}

8. Dots Layout

Similar to the Line layout, but uses dots as separators.

Configuration:

{
    "layout": "dots"
}

9. Bottom Line Layout

A minimal layout that adds a single horizontal line at the very bottom of the information list.

Configuration:

{
    "layout": "bottom_line"
}

Module Grouping

For tree and section layouts, you can define groups in the modules list: 

"modules": [
    // Simple module
    "uptime",
    
    // Group
    {
        "type": "group",
        "title": "Group Title",
        "modules": [
            "os",
            "kernel"
            // You can nest groups too!
        ]
    }
]

Available Modules

  • os: Operating System
  • kernel: Kernel version
  • hostname: Hostname
  • user: Current username
  • datetime: Current date and time
  • uptime: System uptime
  • packages: Package count
  • shell: Current shell
  • terminal: Current terminal emulator
  • wm: Window Manager / Desktop Environment
  • cpu: CPU information
  • gpu: GPU information
  • memory: RAM usage
  • swap: Swap usage
  • disk: Disk usage
  • battery: Battery status
  • local_ip: Local IP address
  • palette: Color palette

Icons

We recommend using Nerd Fonts for icons to ensure they render correctly. You can customize icons in the icons section of your config file. 

"icons": {
    "os": "",
    "cpu": "",
    // ...
}