Documentation

Advanced Usage

The `--benchmark` flag displays timing information for the parallel probe phase and total execution:

en

Changelog

- **crates.io:** `cargo install xfetch-cli` is now supported

en

Code of Conduct

Xfetch contributors and users are expected to collaborate in a respectful, inclusive, and professional way.

en

Configuration

xfetch uses a JSONC (JSON with Comments) configuration file. The default location is `~/.config/xfetch/config.jsonc`. You can generate a default configuration with `xfetch --gen-config` or use a custom path with `xfetch --config <path>`.

en

Contributing

xfetch is written in Rust (edition 2024). To build from source, you need Rust installed (install via `rustup` at rust-lang.org).

en

Custom-X Layout

`custom-x` is the most flexible layout in xfetch: every border line is a **literal template** you write in the `custom_x` config object. You decide the characters, the size, the internal separators, and can add extra lines — nothing is hardcoded.

en

Customization

xfetch offers extensive visual customization through logos, icons, colors, and animation effects. All customization is configured in the JSONC configuration file.

en

Effects

Intro effects animate the content lines when the fetch starts. Instead of printing the result instantly, an effect transforms each line from a scrambled state into its final text over a short duration.

en

Config Roulette

Picks a random (or daily) configuration from a list of paths and loads it. Every xfetch invocation can show a completely different look — different layout, logo, theme, colors, modules, and icons.

en

Layout Override

Forces a specific layout and/or module set at config load time, regardless of what the config or theme file specifies. Runs after theme merge but before rendering.

en

Extensions

Extensions are standalone binaries that hook into the xfetch lifecycle at the config level. Unlike plugins (which provide info lines or animate logos), extensions receive the fully resolved configuration via stdin, modify it, and return a modified version via stdout.

en

Config Generation (`--gen-config`)

`xfetch --gen-config` generates a ready-to-use starter config file. When network is available it also attaches the ASCII logo of your OS/distro.

en

Getting Started with xfetch

xfetch is a cross-platform system information fetching tool written in Rust. It displays details about your operating system, hardware, software, and network in a customizable terminal output with ASCII art or images.

en

Layouts

xfetch supports multiple visual layouts for displaying system information. Each layout arranges modules, groups, and the logo differently. Layouts are selected via the `layout` field in the configuration file.

en

License

xfetch is licensed under the MIT License.

en

Modules

xfetch provides 23 built-in modules and supports unlimited custom modules through its plugin system. Modules are the individual pieces of information displayed in the output.

en

Plugins Index

xfetch provides a set of official plugins for additional functionality.

en

animate-logo

Animates ASCII logos with various color effects.

en

chocolatey

Counts packages installed via Chocolatey (Windows package manager).

en

display-resolution

Detects monitor resolution and refresh rate.

en

docker

Displays Docker container statistics.

en

github-stats

Fetches GitHub user profile statistics.

en

music-player

Displays currently playing music from MPD and/or Spotify.

en

temperature

Reports CPU/SoC temperature from the kernel thermal zones.

en

theme-detection

Detects current desktop theme and color scheme.

en

theme-manager

Browses, searches, and installs themes from a remote or local registry.

en

timezone

Displays current time, date, and timezone information.

en

user-info

Displays user account information.

en

weather

Displays current weather conditions via wttr.in.

en

Plugins

xfetch has a plugin system that allows extending functionality through standalone executables. Plugins communicate with the core via a JSON protocol over stdin/stdout.

en

Presets Reference

xfetch ships with a comprehensive library of preset configurations demonstrating various layouts, visual styles, and plugin integrations. These presets are located in the `configs/` repository.

en

Roadmap

- [x] Initialize Rust project with dependencies

en

Security Policy

If you discover a security vulnerability in **xfetch**, please report it responsibly by contacting:

en

Support

Need help with installation, configuration, layouts, or runtime behavior of **xfetch**?

en

Theme Manager Plugin

The theme-manager plugin allows browsing, searching, inspecting, and installing xfetch themes from the remote theme registry.

en

Themes

The theme system separates visual appearance (colors, icons, layout) from module configuration, allowing you to switch looks without touching your module setup.

en

Fortgeschrittene Nutzung

Das Flag `--benchmark` zeigt Zeitinformationen fur die parallele Probephase und die Gesamtausfuhrungszeit an:

de

Anderungsprotokoll

- **crates.io:** `cargo install xfetch-cli` wird jetzt unterstützt

de

Verhaltenskodex

Von Xfetch-Mitwirkenden und -Benutzern wird erwartet, dass sie auf respektvolle, integrative und professionelle Weise zusammenarbeiten.

de

Konfiguration

xfetch verwendet eine JSONC (JSON mit Kommentaren) Konfigurationsdatei. Der Standardspeicherort ist `~/.config/xfetch/config.jsonc`. Sie konnen eine Standardkonfiguration mit `xfetch --gen-config` generieren oder einen benutzerdefinierten Pfad mit `xfetch --config <pfad>` verwenden.

de

Mitwirken

xfetch ist in Rust (Edition 2024) geschrieben. Um aus dem Quellcode zu bauen, benotigen Sie Rust (installieren Sie es uber `rustup` auf rust-lang.org).

de

Custom-X-Layout

`custom-x` ist das flexibelste Layout in xfetch: Jede Rahmenzeile ist eine **wörtliche Vorlage** (Template), die du im `custom_x`-Objekt der Konfiguration schreibst. Du bestimmst die Zeichen, die Größe, die internen Trennlinien und kannst zusätzliche Zeilen einfügen — nichts ist fest verdrahtet.

de

Anpassung

xfetch bietet umfangreiche visuelle Anpassungsmöglichkeiten durch Logos, Icons, Farben und Animationseffekte. Die gesamte Anpassung wird in der JSONC-Konfigurationsdatei konfiguriert.

de

Effekte

Intro-Effekte animieren die Inhaltszeilen beim Start des Fetch. Statt das Ergebnis sofort auszugeben, transformiert ein Effekt jede Zeile von einem verschlüsselten Zustand in seinen endgültigen Text über eine kurze Dauer.

de

Config Roulette

Wählt eine zufällige (oder tägliche) Konfiguration aus einer Liste von Pfaden aus und lädt sie. Jeder xfetch-Aufruf kann ein völlig anderes Erscheinungsbild zeigen — anderes Layout, Logo, Theme, Farben, Module und Icons.

de

Layout Override

Erzwingt ein bestimmtes Layout und/oder einen Modulsatz beim Laden der Konfiguration, unabhängig davon, was die Konfigurations- oder Theme-Datei vorgibt. Wird nach der Theme-Zusammenführung (Theme Merge), aber vor dem Rendering ausgeführt.

de

Erweiterungen

Erweiterungen sind eigenständige Binardateien, die in den xfetch-Lebenszyklus auf Konfigurationsebene eingreifen. Anders als Plugins (die Infozeilen bereitstellen oder Logos animieren), empfangen Erweiterungen die vollständig aufgelöste Konfiguration über stdin, modifizieren sie und geben eine modifizierte Version über stdout zurück.

de

Konfigurationsgenerierung (`--gen-config`)

`xfetch --gen-config` erzeugt eine gebrauchsfertige Startkonfiguration. Wenn eine Internetverbindung verfügbar ist, wird zusätzlich das ASCII-Logo deines OS/der Distribution eingefügt.

de

Erste Schritte mit xfetch

xfetch ist ein plattformunabhangiges Systeminformations-Tool geschrieben in Rust. Es zeigt Details zu Ihrem Betriebssystem, Ihrer Hardware, Software und Ihrem Netzwerk in einer anpassbaren Terminalausgabe mit ASCII-Kunst oder Bildern an.

de

Layouts

xfetch unterstutzt mehrere visuelle Layouts zur Anzeige von Systeminformationen. Jedes Layout ordnet Module, Gruppen und das Logo unterschiedlich an. Layouts werden uber das Feld `layout` in der Konfigurationsdatei ausgewahlt.

de

Lizenz

xfetch ist unter der MIT-Lizenz lizenziert.

de

Module

xfetch bietet 23 eingebaute Module und unterstutzt unbegrenzt viele benutzerdefinierte Module durch sein Plugin-System. Module sind die einzelnen Informationsstucke, die in der Ausgabe angezeigt werden.

de

Plugin-Index

xfetch bietet eine Reihe offizieller Plugins für zusätzliche Funktionalität.

de

animate-logo

Animiert ASCII-Logos mit verschiedenen Farbeffekten.

de

chocolatey

Zählt die über Chocolatey installierten Pakete (Windows-Paketmanager).

de

display-resolution

Erkennt Monitorauflösung und Bildwiederholrate.

de

docker

Zeigt Docker-Container-Statistiken an.

de

github-stats

Ruft GitHub-Benutzerprofilstatistiken ab.

de

music-player

Zeigt die aktuelle Musikwiedergabe von MPD und/oder Spotify an.

de

temperature

Meldet die CPU/SoC-Temperatur aus den thermischen Zonen des Kernels.

de

theme-detection

Erkennt aktuelles Desktop-Theme und Farbschema.

de

theme-manager

Durchsucht und installiert Themes aus einer entfernten oder lokalen Registry.

de

timezone

Zeigt aktuelle Uhrzeit, Datum und Zeitzoneninformationen an.

de

user-info

Zeigt Benutzerkontoinformationen an.

de

weather

Zeigt aktuelle Wetterbedingungen via wttr.in an.

de

Plugins

xfetch hat ein Plugin-System, das die Erweiterung der Funktionalität durch eigenständige ausführbare Programme ermoglicht. Plugins kommunizieren mit dem Kern über ein JSON-Protokoll über stdin/stdout.

de

Presets-Referenz

xfetch wird mit einer umfassenden Bibliothek von Preset-Konfigurationen ausgeliefert, die verschiedene Layouts, visuelle Stile und Plugin-Integrationen demonstrieren. Diese Presets befinden sich im `configs/`-Repository.

de

Fahrplan

- [x] Rust-Projekt mit Abhangigkeiten initialisieren

de

Sicherheitsrichtlinie

Wenn Sie eine Sicherheitslucke in **xfetch** entdecken, melden Sie diese bitte verantwortungsvoll per E-Mail:

de

Support

Benotigen Sie Hilfe bei Installation, Konfiguration, Layouts oder dem Laufzeitverhalten von **xfetch**?

de

Theme Manager Plugin

Das theme-manager Plugin ermoglicht das Durchsuchen, Suchen, Inspizieren und Installieren von xfetch Themes aus der entfernten Theme-Registry.

de

Themes

Das Theme-System trennt das visuelle Erscheinungsbild (Farben, Icons, Layout) von der Modulkonfiguration, sodass du das Aussehen wechseln kannst, ohne deine Moduleinrichtung anzutasten.

de

Uso Avanzado

La bandera `--benchmark` muestra información de tiempo para la fase de sondeo paralelo y la ejecución total:

es

Registro de Cambios

- **crates.io:** ahora se admite `cargo install xfetch-cli`

es

Código de Conducta

Se espera que los colaboradores y usuarios de xfetch colaboren de manera respetuosa, inclusiva y profesional.

es

Configuración

xfetch utiliza un archivo de configuración JSONC (JSON con comentarios). La ubicación predeterminada es `~/.config/xfetch/config.jsonc`. Puede generar una configuración predeterminada con `xfetch --gen-config` o usar una ruta personalizada con `xfetch --config <ruta>`.

es

Contribuir

xfetch está escrito en Rust (edición 2024). Para compilar desde el código fuente, necesita Rust instalado (instálelo mediante `rustup` en rust-lang.org).

es

Diseño Custom-X

`custom-x` es el diseño más flexible de xfetch: cada línea de borde es una **plantilla literal** que escribís en el objeto `custom_x` de la config. Vos decidís los caracteres, el tamaño, los separadores internos, y podés agregar líneas extra — nada está hardcodeado.

es

Personalización

xfetch ofrece una amplia personalización visual a través de logos, iconos, colores y efectos de animación. Toda la personalización se configura en el archivo de configuración JSONC.

es

Efectos

Los efectos de introducción animan las líneas de contenido cuando arranca el fetch. En lugar de imprimir el resultado al instante, cada efecto transforma cada línea desde un estado codificado hasta su texto final durante una corta duración.

es

Config Roulette

Elige una configuración aleatoria (o diaria) de una lista de rutas y la carga. Cada invocación de xfetch puede mostrar un aspecto completamente diferente — diferente diseño, logo, tema, colores, módulos e iconos.

es

Layout Override

Fuerza un diseño y/o conjunto de módulos específico al cargar la configuración, independientemente de lo que especifique el archivo de configuración o el tema. Se ejecuta después de la fusión del tema pero antes del renderizado.

es

Extensiones

Las extensiones son binarios independientes que se enganchan en el ciclo de vida de xfetch a nivel de configuración. A diferencia de los plugins (que proporcionan líneas de información o animan logos), las extensiones reciben la configuración completamente resuelta por stdin, la modifican y devuelven una versión modificada por stdout.

es

Generación de Configuración (`--gen-config`)

`xfetch --gen-config` genera un archivo de configuración inicial listo para usar. Cuando hay conexión a internet, además adjunta el logo ASCII de tu SO/distribución.

es

Primeros Pasos con xfetch

xfetch es una herramienta de obtención de información del sistema multiplataforma escrita en Rust. Muestra detalles sobre su sistema operativo, hardware, software y red en una salida de terminal personalizable con arte ASCII o imágenes.

es

Diseños

xfetch admite múltiples diseños visuales para mostrar información del sistema. Cada diseño organiza los módulos, grupos y el logo de manera diferente. Los diseños se seleccionan mediante el campo `layout` en el archivo de configuración.

es

Licencia

xfetch está licenciado bajo la Licencia MIT.

es

Módulos

xfetch proporciona 23 módulos integrados y admite módulos personalizados ilimitados a través de su sistema de plugins. Los módulos son las piezas individuales de información que se muestran en la salida.

es

Índice de Plugins

xfetch proporciona un conjunto de plugins oficiales para funcionalidad adicional.

es

animate-logo

Anima logos ASCII con varios efectos de color.

es

chocolatey

Cuenta los paquetes instalados vía Chocolatey (gestor de paquetes de Windows).

es

display-resolution

Detecta la resolución del monitor y la tasa de refresco.

es

docker

Muestra estadísticas de contenedores Docker.

es

github-stats

Obtiene estadísticas del perfil de usuario de GitHub.

es

music-player

Muestra la música reproduciéndose actualmente desde MPD y/o Spotify.

es

temperature

Informa de la temperatura de la CPU/SoC desde las zonas térmicas del kernel.

es

theme-detection

Detecta el tema de escritorio y esquema de colores actual.

es

theme-manager

Navega, busca e instala temas desde un registro remoto o local.

es

timezone

Muestra la hora actual, fecha e información de zona horaria.

es

user-info

Muestra información de la cuenta de usuario.

es

weather

Muestra las condiciones climáticas actuales vía wttr.in.

es

Plugins

xfetch tiene un sistema de plugins que permite extender la funcionalidad a través de ejecutables independientes. Los plugins se comunican con el núcleo mediante un protocolo JSON sobre stdin/stdout.

es

Referencia de Predefinidos

xfetch incluye una biblioteca completa de configuraciones predefinidas que demuestran varios diseños, estilos visuales e integraciones de plugins. Estos predefinidos se encuentran en el repositorio `configs/`.

es

Hoja de Ruta

- [x] Inicializar proyecto Rust con dependencias

es

Política de Seguridad

Si descubre una vulnerabilidad de seguridad en **xfetch**, repórtela de manera responsable contactando:

es

Soporte

¿Necesita ayuda con la instalación, configuración, diseños o comportamiento en tiempo de ejecución de **xfetch**?

es

Plugin Theme Manager

El plugin theme-manager permite navegar, buscar, inspeccionar e instalar temas de xfetch desde el registro remoto de temas.

es

Temas

El sistema de temas separa la apariencia visual (colores, iconos, diseño) de la configuración de módulos, permitiendo cambiar el aspecto sin tocar la configuración de los módulos.

es
108 of 108 documents