Skip to content

getting-started.md

Latest commit

 

History

History
256 lines (186 loc) · 8.39 KB

getting-started.md

File metadata and controls

256 lines (186 loc) · 8.39 KB
Raw

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.

Schnellinstallation

Linux und macOS

curl -fsSL https://raw.githubusercontent.com/xfetch-cli/xfetch/main/install.sh | bash

Dies installiert xfetch nach ~/.local/bin/, generiert eine erste Konfiguration unter ~/.config/xfetch/config.jsonc mit xfetch --gen-config und fugt optional das Binarbildverzeichnis zu Ihrem PATH hinzu.

So passen Sie den Installationspfad an:

curl -fsSL https://raw.githubusercontent.com/xfetch-cli/xfetch/main/install.sh | bash -s -- --prefix ~/myapps

Flags:

Flag Beschreibung
--local Das lokale Repository anstelle von Klonen verwenden
--prefix <dir> Installationspraefix (Standard: ~/.local)
--bin-dir <dir> Binarbildverzeichnis (Standard: ~/.local/bin)
--config-dir <dir> Konfigurationsverzeichnis (Standard: ~/.config/xfetch)
--no-modify-path Das Binardir nicht zum PATH in der Shell-RC hinzufugen
--yes Automatische Bestatigung aller Eingabeaufforderungen
--skip-config Kopieren der Standardkonfiguration uberspringen
--no-cargo-install Ein vorgebautes Binary anstelle von Cargo-Build verwenden
--install-deps Fehlende Systemabhangigkeiten automatisch installieren

Windows (PowerShell)

Prebuilt binary (no Rust needed):

irm https://raw.githubusercontent.com/xfetch-cli/xfetch/main/install-prebuilt.ps1 | iex

From source:

irm https://raw.githubusercontent.com/xfetch-cli/xfetch/main/install.ps1 | iex

Manueller Build aus dem Quellcode

git clone https://github.com/xfetch-cli/xfetch.git
cd xfetch
cargo build --release
cp target/release/xfetch ~/.local/bin/

Arch Linux (AUR)

xfetch ist im AUR als xfetch-git verfugbar. Bauen und installieren Sie es mit makepkg oder Ihrem bevorzugten AUR-Helfer:

git clone https://aur.archlinux.org/xfetch-git.git
cd xfetch-git
makepkg -si

Paketmanager

xfetch ist über Homebrew verfügbar:

brew tap xfetch-cli/tap
brew install xfetch

Von crates.io:

cargo install xfetch-cli

Aus dem PKGBUILD des Repositories:

git clone https://github.com/xfetch-cli/xfetch.git
cd xfetch
makepkg -si

Erster Start

Nach der Installation fuhren Sie einfach aus:

xfetch

Sie sollten Systeminformationen zusammen mit einem ASCII-Logo sehen, das dieser Struktur ahnelt:

__  __                               OS: Arch Linux x86_64
  \ \/ /                             Kernel: 6.6.87.2-arch1-1
   \  /                              Uptime: 2 hours, 15 mins
   /  \                              Packages: 657 (pacman)
  /_/\_\                             WM: Hyprland
 /____/linux                         Shell: zsh
---------BEGIN PUBLIC KEY----------   CPU: Intel(R) Core(TM) i5-7400 @ 3.00GHz (4)
...                                  GPU: NVIDIA GeForce RTX 3060
----------END PUBLIC KEY-----------   Memory: 3.10 GiB / 7.74 GiB (40%)
                                     Disk: 120.5 GiB / 256 GiB (47%) - ext4
                                     Battery: 85% [Charging]

Befehlszeilen-Schnittstelle

Globale Flags

Flag Beschreibung
-c, --config <PATH> Pfad zu einer benutzerdefinierten Konfigurationsdatei (JSONC-Format)
--gen-config Standardkonfigurationsdatei am Standard-Konfigurationspfad generieren
--layout <name> Layout fur --gen-config (Standard: section)
--logo <id> Logo-Id (z. B. arch, windows-11) fur --gen-config (erfordert Netzwerkzugriff auf den Logo-Katalog)
--clean-cache Die Cache-Datenbank leeren
--benchmark Zeitinformationen fur parallele Proben anzeigen
--daemon Den animierten Daemon starten
--daemon-stop Den Daemon stoppen
--no-daemon-live Den Live-Statistik-Daemon deaktivieren, auch wenn er in der Konfiguration aktiviert ist
--daemon-live-stop Den laufenden Live-Statistik-Daemon stoppen
--daemon-live-reload Hot-Reload im Live-Statistik-Daemon erzwingen

Plugin-Unterbefehle

xfetch plugin install <name>      Ein Plugin installieren (lokaler Pfad oder aus Repository)
xfetch plugin list                Alle installierten Plugins auflisten
xfetch plugin remove <name>       Ein installiertes Plugin entfernen

Erweiterungs-Unterbefehle

xfetch extension install <name>   Eine Erweiterung installieren (lokaler Pfad oder aus Repository)
xfetch extension list             Alle installierten Erweiterungen auflisten
xfetch extension remove <name>    Eine installierte Erweiterung entfernen

Theme-Unterbefehle

xfetch theme list                 Installierte Themes auflisten
xfetch theme set <name>           Ein Theme aktivieren (setzt das Feld "theme" in config.jsonc)
xfetch theme remove <name>        Eine Theme-Datei entfernen
xfetch theme export <name>        Aktuelle visuelle Konfiguration als Theme-Datei exportieren

Effekt-Unterbefehle

xfetch effects install <name>     Ein Intro-Effekt installieren
xfetch effects list               Installierte Effekte auflisten
xfetch effects remove <name>      Einen Effekt entfernen

Update-Unterbefehl

xfetch update                     Nach neuerer Version suchen und installieren
xfetch update --check             Nur melden; Exit 1 bei neuerer Version
xfetch update --prebuilt          In-Place-Prebuilt-Update erzwingen (Unix)
xfetch update --bin-dir <dir>     Verzeichnis des Binaries mit --prebuilt
xfetch update --yes               Bestätigung überspringen

Nutzungsbeispiele

# Mit Standardkonfiguration ausfuhren
xfetch

# Mit einer benutzerdefinierten Konfiguration ausfuhren
xfetch --config ~/.config/xfetch/my-config.jsonc

# Eine Standardkonfiguration generieren
xfetch --gen-config

# Im Benchmark-Modus ausfuhren
xfetch --benchmark

# Zwischengespeicherte Daten loschen
xfetch --clean-cache

# Ein Plugin installieren
xfetch plugin install animate-logo

# Installierte Plugins auflisten
xfetch plugin list

# Ein Plugin entfernen
xfetch plugin remove docker

# Nach einer neueren Version suchen
xfetch update --check

# Auf die neueste Version aktualisieren
xfetch update

Umgebungsvariablen

Variable Beschreibung
XFETCH_PLUGIN_REPO Die Standard-Plugin-Git-Repository-URL uberschreiben
XFETCH_PLUGIN_DEV_DIR Den Suchpfad fur das Plugin-Entwicklungsverzeichnis uberschreiben
XFETCH_LOGOS_URL Die URL des Logo-Katalogs uberschreiben (verwendet von --logo mit --gen-config)
XFETCH_EFFECT_REPO Die URL des Effekt-Git-Repositorys uberschreiben
XFETCH_WASM_LOG_LEVEL Log-Schwelle fuer WebAssembly-Gaeste: off, error, warn (Standard), info, debug
XFETCH_UPDATE_API Ueberschreibt den GitHub-API-Endpunkt fuer xfetch update (Mirrors)
CARGO_NET_GIT_FETCH_WITH_CLI Git CLI zum Abrufen verwenden (wird bei Plugin-Installation automatisch gesetzt)

Aktualisierung

xfetch kann selbst nach neueren Releases suchen und sie installieren:

xfetch update --check   # nur melden; Exit 1 bei neuerer Version
xfetch update           # neueste Version installieren
xfetch update --yes     # Bestätigung überspringen

Der Befehl erkennt zuerst, wie das Binary installiert wurde:

  • Prebuilt-Installationen (install-prebuilt.sh, meist ~/.local/bin): Das Release-Asset wird geladen, gegen SHA256SUMS geprueft, entpackt und atomar ueber die aktuelle Datei verschoben. Ein einzelnes xfetch.bak behaelt das vorherige Binary.
  • cargo install-Binaries: Aktualisierung ueber cargo install xfetch-cli --force --locked.
  • Paketmanager und lokale Builds: werden nie ersetzt; der Befehl zeigt den passenden Befehl an.

xfetch update --prebuilt --bin-dir <dir> erzwingt das In-Place-Update von <dir>/xfetch (nur Unix). Unter Windows gibt es den Prebuilt-Pfad noch nicht; nutze cargo install xfetch-cli --force.

Deinstallation

Schnelldeinstallation

curl -fsSL https://raw.githubusercontent.com/xfetch-cli/xfetch/main/uninstall.sh | bash

Manuelle Deinstallation

rm ~/.local/bin/xfetch
rm -rf ~/.config/xfetch

Entfernen Sie anschlieend alle PATH-Anderungen aus Ihrer Shell-RC-Datei, falls der Installer sie hinzugefugt hat.