Skip to content

Repository files navigation

XFetch banner

Themes

The official theme registry for xfetch.

Themes are partial JSONC configs: they declare only what they want to change (colors, logo color, layout, palette style), and the core merges them over your config. Icons are not part of themes — they are a per-user font choice.

Structure

themes/
├── index.json        # Registry index: metadata + source for every theme
├── schema.json       # JSON schema for the index
├── colors/           # The theme files themselves (*.jsonc)
├── README.md
└── CHANGELOG.md

How it works

  1. xfetch loads "theme": "<name>" from your config and merges the theme over the defaults.
  2. xfetch theme list|set|remove|export manage installed themes locally.
  3. The theme-manager plugin (see xfetch-cli/plugins) lists, searches, inspects and installs themes from this registry.

Registry index format

{
    "themes": [
        {
            "name": "dracula",
            "author": "xscriptor",
            "version": "1.0.0",
            "description": "Dark magenta, red, and cyan palette ...",
            "layout": "section",
            "palette_style": "circles",
            "tags": ["dark", "dracula", "popular"],
            "source": "https://raw.githubusercontent.com/xfetch-cli/themes/main/colors/dracula.jsonc"
        }
    ]
}

Adding a theme

  1. Create colors/<name>.jsonc with only the fields you want to change (colors, logo_color, layout, palette_style, show_colors, ...).
  2. Add an entry to index.json with the metadata above; tag it dark or light so users can pick for their terminal.
  3. Add a note in CHANGELOG.md and open a PR.

Theme file example

{
    "layout": "section",
    "show_colors": true,
    "palette_style": "circles",
    "logo_color": "Magenta",
    "colors": {
        "os": "Magenta",
        "cpu": "Red",
        "memory": "Yellow",
        "shell": "Green"
    }
}

X

X Web & X Github Profile & Xscriptor web

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages