steamfetch

neofetch for Steam - Display your Steam stats in terminal with style.

Screenshot

Installation

Install Script (Recommended)

curl -fsSL https://raw.githubusercontent.com/unhappychoice/steamfetch/main/install.sh | bash

Homebrew (macOS / Linux)

brew install unhappychoice/tap/steamfetch

From crates.io

cargo install steamfetch

Download Binary

Download the latest release from GitHub Releases.

Build from Source

git clone https://github.com/unhappychoice/steamfetch.git
cd steamfetch
cargo build --release
./target/release/steamfetch

Setup

1. Get Your Steam API Key

1. Visit https://steamcommunity.com/dev/apikey
2. Log in with your Steam account
3. Create a new API key

2. Find Your Steam ID

Visit https://steamid.io/ and enter your Steam profile URL.

3. Configure

On first run, steamfetch creates a config file at ~/.config/steamfetch/config.toml.

Edit the config file:

[api]
steam_api_key = "your_api_key_here"
steam_id = "your_steam_id_here"

[display]
show_top_games = 5
show_recently_played = true
show_achievements = true
show_rarest = true

Or use environment variables (takes precedence over config file):

export STEAM_API_KEY="your_api_key_here"
export STEAM_ID="your_steam_id_here"

Note: If Steam is running, STEAM_ID is auto-detected via Native SDK.

Usage

# Display your Steam stats
steamfetch

# Show profile avatar image instead of ASCII logo
steamfetch --image

# Specify image protocol (auto, kitty, iterm, sixel)
steamfetch --image --image-protocol sixel

# Demo mode (no API key required)
steamfetch --demo

# Demo mode with image
steamfetch --demo --image

# Show config file path
steamfetch --config-path

# Use custom config file
steamfetch --config /path/to/config.toml

# Verbose output for debugging
steamfetch --verbose

# Show version
steamfetch --version

# Show help
steamfetch --help

Features

• Steam account stats (level, member since, games owned)
• Playtime statistics with fun titles
• Achievement progress and perfect games count
• Top played games list
• Recently played games (last 2 weeks)
• Rarest achievement display
• Beautiful SteamOS ASCII art with gradient colors
• Image display: Show your Steam avatar with --image flag
• Demo mode for testing without API setup

Image Display

Use --image to show your Steam profile avatar instead of the ASCII logo.

Supported protocols:

• Sixel - Windows Terminal, WezTerm, foot, mlterm, xterm
• Kitty - Kitty terminal
• iTerm2 - iTerm2
• Block characters - Fallback for unsupported terminals

Protocol is auto-detected by default. Use --image-protocol to override.

Images are cached locally at ~/.cache/steamfetch/images/.

How It Works

With Steam Client Running

Uses Steamworks SDK for accurate game detection:

• Automatically detects logged-in Steam user
• Checks ownership for all known Steam games (~73,000 titles)
• Most accurate game count and achievement statistics

Without Steam Client

Falls back to Steam Web API:

• Requires STEAM_API_KEY and STEAM_ID environment variables
• Returns games visible in your library
• Some owned games may not appear in API response

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'feat: add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

ISC License - see LICENSE for details.