Skip to content
DrackrathPublic

About

Headless command-line Steam client for Linux and Windows, written in Rust. Install, update and launch Steam games (native or Proton/Wine) from the terminal, plus Steam Cloud saves, Workshop, DLC, collections and friends & chat. An open-source SteamCMD and OpenSteamClient alternative, scriptable with --json.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

125 stars

Watchers

0 watching

Forks

Repository files navigation

Aurelia, the command-line Steam client and launcher written in Rust

Aurelia: a command-line Steam client for Linux and Windows

A fast, lightweight, headless Steam launcher and library manager written in Rust. Install, update and play your Steam games entirely from the terminal.

License: GPL-3.0-or-later Built with Rust Status: Beta AUR crates.io


Discord

Warning

Disclaimer: read before use. Aurelia is an independent, unofficial project and is not affiliated with, authorized, sponsored, or endorsed by Valve or Steam in any way. "Steam" and "Valve" are trademarks of Valve Corporation.

  • It modifies Steam's files directly. Doing so may corrupt or damage your Steam installation, potentially forcing a full reinstallation. Back up your data first.
  • No warranty for games launched outside the official Steam launcher. Titles started through Aurelia bypass the normal Steam client and may not behave as expected.

Use Aurelia entirely at your own risk. The authors accept no liability for damage to your Steam installation, lost data, or banned or suspended accounts.

Aurelia is a pure command-line Steam launcher and library manager. No CEF, no WebViews, no GUI. It talks to Steam's real network protocols through steam-vent, so you can log in, manage your library, install and update games, sync Steam Cloud saves, manage Steam Workshop content, see your friends and chat with them, and launch titles (natively or through Proton or Wine) entirely from a terminal or a script.

Because it never needs a desktop session, it runs where the official Steam client can't: over SSH, on a headless Linux server, in a container, on a low-memory box, or as one step inside a shell script. Every command speaks --json, so it is equally at home as a backend for another launcher.

It is the modern successor to OpenSteamClient, rebuilt in Rust for a smaller footprint, memory safety, and a scriptable, headless-friendly workflow. It is also a full-fledged alternative to SteamCMD, one that can launch the games it installs.

aurelia login
aurelia list --installed
aurelia install 1245620
aurelia play 1245620

Contents


Why Aurelia?

  • No web technology. No Electron, CEF, or embedded browser. Idle memory stays under ~50 MB instead of the official Steam app's hundreds.
  • Fast and scriptable. A pure Rust CLI: instant startup, easy to automate, and every command speaks --json for machine-readable output.
  • Linux first. 64-bit clean, with first-class Proton and Wine management, and it runs on Windows too. No X11 or Wayland session required for library and download work, so it works over SSH and on headless servers.
  • Deep Steam integration. PICS metadata, the content CDN, Steam Cloud, app ownership tickets, depot browsing, DLC management, and Steam Workshop, all built on open, documented protocols.
  • Open source. GPL-3.0-or-later licensed, with no dependency on opaque 32-bit legacy Steam binaries.

How it compares

Feature Official Steam OpenSteamClient SteamCMD Aurelia
Architecture Electron + C++ C++ with Qt C++ (proprietary) Pure Rust
Idle RAM ~400-800 MB ~100-200 MB ~50 MB (per run) < 50 MB
Interface Desktop GUI Desktop GUI CLI (scriptable) CLI (scriptable)
Scope Everything Library + launch Install, update, Workshop Library, install, launch, Cloud, Workshop, DLC, friends, chat
Download engine CDN + P2P LAN Standard CDN Standard CDN Multi-threaded CDN
Authentication Full Core Full (+ anonymous) Full (tokens, mobile app, Guard)
Steam integration Native Partial Content only Deep (PICS, CDN, Cloud, tickets)
Platforms Windows, Linux, macOS Windows, Linux Windows, Linux, macOS Linux (first), Windows
Open source No Yes No Yes (GPL-3.0-or-later)

vs. SteamCMD. SteamCMD is Valve's official command-line tool and the closest analog to Aurelia, but it is content-only: it downloads and updates app and Workshop files (often anonymously, for dedicated servers) and little else. Aurelia is a full launcher and library manager. On top of installing and updating, it lists and searches your library, launches games (natively or via Proton or Wine), syncs Steam Cloud saves, manages DLC and Workshop subscriptions, reads achievements, and does friends & chat, with every command scriptable via --json. SteamCMD is proprietary and ships only as a prebuilt binary. Aurelia is open source (GPL-3.0-or-later).


Project status

Aurelia is in experimental beta. The core is highly functional: authentication, library management, installs and updates, integrity verification, DLC handling, Steam Cloud sync, and Proton or Wine launching all work today.

Area Status What works
Authentication ✅ Password, Steam Guard (email and device codes), Mobile App confirmation, refresh-token session restore
Library ✅ Fetch owned games, scan local installs, search & filter, Family Sharing
Install & updates ✅ 4-phase download pipeline (manifest → security → chunks) that downloads files in parallel from a pool of the least-loaded CDN servers, retries failed chunks on another server and times out stalled requests, plus updates, uninstall, integrity verification, and moving installs between library folders, with Steam's appmanifest and libraryfolders.vdf kept in sync. Installs run in the background daemon, can be listed, paused, resumed, cancelled, and kept across restarts in an install backlog that resumes from the files already on disk (install list, install pause, install resume, install stop, install forget, optional automatic resume with config install-resume auto)
Version pinning and downgrade ✅ Install & pin a specific depot manifest (downgrade, manifests, pin, unpin), holding a game at an older build
Localized metadata ✅ Store text (info) and achievement names and descriptions follow a --lang flag or the config language default, used by the Heroic Steam integration
DLC ✅ Install, enable or disable, and per-DLC ownership and install status
Steam Cloud ✅ Enumerate, download, upload save data
Proton and Wine ✅ Runtime discovery, a download manager (official Valve Proton, GE builds, and Proton-CachyOS with AVX2 or x86_64_v3 microarch selection), automatic modern unified-layout discovery (Proton 11+, GE, CachyOS, WOW64-aware) with strict bitness filtering, per-game version pinning, and launch integration. Depot-aware executable selection (native vs Proton), running-game tracking, and graceful or forced stop (running, stop --force). Launch records survive crashes and reboots: each pairs the PID with the process start time, so a stale record with a recycled PID is cleared, never signalled
Self-contained Windows Steam runtime ✅ Install or repair a master Wine Steam prefix (steam-runtime install, repair, stop, uninstall, status) to satisfy Steamworks and DRM handshakes without a host Steam client. play --steam falls back to it automatically when no host Steam is installed (config steam-runtime-policy auto|on|off). Linux only: Proton/Wine runners are Linux binaries, so on Windows Aurelia uses the installed Steam client instead
Optional launch plugins ✅ Linux, opt-in, never bundled: luxtorpeda native engines, and umu-launcher (Proton via umu-run). Both are downloaded on demand and routed per-game
Steam integration (opt-in) ✅ Launch with real Steam integration (play --steam): the host Steam client bridged in, started silently if needed, or the in-Wine Steam runtime when no host Steam exists, for Steamworks and DRM. Auto-enabled on Family-Shared games
Depot browser ✅ List depots, inspect manifest trees, download single files
Workshop ✅ Browse and search, install and uninstall, subscribe, collections, rate, and read or post comments
Friends & chat ✅ Friends roster with live persona status and current game, user profiles and wishlists over the Steam connection (by SteamID64, profile URL or friend name), send or cancel friend requests, plus direct messaging (send, history, and an interactive live session). Presence is configurable, defaulting to invisible, and isn't announced while the Steam client runs on the same machine
Inventory & market ✅ Read-only View your inventory, look up item prices, search the Community Market, and see your wallet and listings. Buying & selling are planned
Collections and categorization ✅ Create, rename and delete library collections, add and remove games, a list COLLECTIONS column and --collection filter, and on-demand pull, push and sync with Steam's cloud collections

Install

Arch Linux (AUR)

yay -S aurelia          # or: paru -S aurelia

Nix and NixOS (flake)

nix run github:Drackrath/Aurelia          # run it once
nix profile install github:Drackrath/Aurelia   # install it

crates.io (Cargo)

Needs the build prerequisites. The crate is called aurelia-steam, and the command it installs is aurelia:

cargo install aurelia-steam

Debian and Ubuntu (.deb)

Grab the .deb for your architecture from the latest release:

sudo apt install ./aurelia_*_amd64.deb

Prebuilt binaries (Linux, Windows)

Every release ships static-ish binaries for linux_x86_64, linux_arm64, windows_x86_64 and windows_arm64. See the releases page.

curl -LO https://github.com/Drackrath/Aurelia/releases/latest/download/aurelia_linux_x86_64
chmod +x aurelia_linux_x86_64 && sudo mv aurelia_linux_x86_64 /usr/local/bin/aurelia
aurelia --help

Each release also publishes SHA256SUMS, signed with Sigstore by the release workflow (SHA256SUMS.sig, SHA256SUMS.pem). To check a download before installing it:

for f in SHA256SUMS SHA256SUMS.sig SHA256SUMS.pem; do
  curl -LO "https://github.com/Drackrath/Aurelia/releases/latest/download/$f"
done
sha256sum --ignore-missing -c SHA256SUMS          # the binary matches the published hash
cosign verify-blob SHA256SUMS \
  --signature SHA256SUMS.sig --certificate SHA256SUMS.pem \
  --certificate-identity-regexp '^https://github\.com/Drackrath/Aurelia/\.github/workflows/release\.yml@refs/tags/v' \
  --certificate-oidc-issuer https://token.actions.githubusercontent.com

Build from source

Prerequisites

You'll need a Rust toolchain (edition 2024).

On Linux, install the system dependencies first (Ubuntu 24.04 example):

sudo apt-get update
sudo apt-get install build-essential pkg-config libssl-dev libx11-dev libxi-dev \
  libxrandr-dev libxinerama-dev libxcursor-dev libxkbcommon-dev libasound2-dev \
  libudev-dev libwayland-dev libgtk-3-dev libpulse-dev libdbus-1-dev \
  libegl1-mesa-dev libgles2-mesa-dev liblzma-dev

Windows and macOS need only the Rust toolchain.

Build

git clone https://github.com/Drackrath/Aurelia.git
cd Aurelia
cargo build --release

The binary is produced at target/release/aurelia (aurelia.exe on Windows).


Published crates

Aurelia is published on crates.io as three crates, all licensed under GPL-3.0-or-later:

Crate What it is Source
aurelia-steam The aurelia command and its library Drackrath/Aurelia
aurelia-steam-cdn Depot downloads, forked from steam-cdn Drackrath/aurelia-steam-cdn
aurelia-steam-vent-chat Friend chat, forked from steam-vent-chat Drackrath/aurelia-steam-vent-chat

To use Aurelia as a library, add aurelia-steam to your project and import it as aurelia:

cargo add aurelia-steam
use aurelia::core::utils::is_safe_dir_name;

assert!(!is_safe_dir_name("../x"));

The library is pre-1.0, so its API may change between releases.


Usage

Aurelia is driven entirely from the command line. Run aurelia --help for the full list of subcommands, or aurelia <command> --help for a specific one.

# Account
aurelia login                        # authenticate (prompts for credentials and Steam Guard)
aurelia login --qr --timeout 120     # scan a QR code with the Steam Mobile app; give up after 120 s
aurelia logout                       # clear the stored session
aurelia account                      # show account details

# Library
aurelia list                         # list your library
aurelia list --installed             # only installed games
aurelia list --search elden          # filter by name
aurelia list --online                # add an ONLINE column (needs-connection heuristic)
aurelia info 690830                  # game details (description, release, reviews, tags, rating, DLC)
aurelia info 690830 --extended       # + requirements, Metacritic, genres, categories
aurelia info 690830 --lang german    # localize store text (falls back to config, then English)
aurelia info 690830 --country DE     # quote the price for a region (falls back to config, locale, US)
aurelia price 690830 --compare US,DE,JP   # compare a game's price and discount end across regions
aurelia search "no man's sky"        # find app ids by title (store search over the Steam connection)
aurelia deals                        # discounted top sellers in your region (--scope top-sellers|specials)
aurelia similar 275850               # games Steam considers similar
aurelia players 730                  # current in-game player count
aurelia events                       # store-wide sales and events currently running
aurelia news 275850                  # recent announcements
aurelia reviews 275850 -t negative   # user reviews, paged via --cursor
aurelia dlc 690830                   # list a game's DLC with ownership and install status
aurelia drm 690830                   # verify DRM/ownership tickets headlessly (no Steam client)
aurelia achievements 620             # your achievements for a game (unlock state + rarity)
aurelia achievements 620 --lang german  # localize achievement names and descriptions
aurelia image 1245620                # fetch cover art to the cache (prints the path)
aurelia image 1245620 -o cover.jpg   # save artwork to a specific file
aurelia image 1245620 --list --probe # every store asset URL (art, screenshots, trailers), HEAD-checked

# Install & maintain
aurelia install 1245620              # download & install a game by app id
aurelia install 1245620 --library D:\SteamLibrary  # install onto a specific drive or library
aurelia libraries                    # list Steam library folders (one per drive) + free space
aurelia install list                 # running installs and the backlog (paused, stopped, interrupted)
aurelia install pause 1245620        # pause a running install; keep its partial files
aurelia install resume 1245620       # resume a paused/interrupted install
aurelia install resume --all         # resume every backlog entry, one at a time
aurelia install stop 1245620         # cancel a running install; keep it in the backlog
aurelia install forget 1245620       # remove an entry without deleting partial files
aurelia install forget 1245620 --delete-files
                                      # remove the entry and safe partial files
aurelia update 1245620               # download the latest manifest
aurelia verify 1245620               # verify installed files
aurelia uninstall 1245620            # remove a game (--delete-prefix wipes its prefix)
aurelia move 1245620 D:\SteamLibrary # move an install to another library (updates Steam data)
aurelia relink 1245620 D:\SteamLibrary  # re-point Steam at already-moved files (no copy)
aurelia import 1245620 D:\SteamLibrary  # register existing on-disk files with Steam
aurelia available 1245620            # is it installed and present on disk?
aurelia duplicates                   # games installed in several libraries at once
                                     # (a duplicate makes a game re-report updates forever.
                                     #  prints the copies to delete, removes nothing itself)

# Downgrade & version pinning
aurelia manifests 1245620            # each depot's current manifest id per branch
aurelia downgrade 1245620 --depot 1245621 --manifest 8593343465227540543  # install an older build & pin it
aurelia pin 1245620                  # lock the current install (block Aurelia updates)
aurelia unpin 1245620                # release the pin
# Older manifest ids aren't exposed by Steam. Find them on SteamDB:
#   https://steamdb.info/depot/<depot_id>/manifests/

# DLC
aurelia enable 2001                  # enable an installed DLC for its base game
aurelia disable 2001                 # disable a DLC

# Branches & depots
aurelia branches 1245620             # list beta branches
aurelia set-branch 1245620 beta      # switch branch
aurelia depots 1245620               # list depots
aurelia launch-options 1245620       # list Steam launch configs (exe, args, platform; `--json` adds `installed`)

# Launch
aurelia play 1245620                 # launch a game and wait for it to exit
aurelia play 1245620 --proton experimental   # Linux: force a specific Proton or Wine runner
aurelia play 1245620 --steam         # run with Steam online features (Family Sharing, DRM)
aurelia launch-targets 1245620       # installed builds + Steam modes, and the `play` flags for each
aurelia play 1245620 --platform linux        # Linux: run the native build (or `windows` via Proton)
aurelia play 1245620 --steam-mode host       # one launch: `runtime` (in-Wine), `host` or `none`
aurelia play 1245620 --launch-option 3       # one launch: an entry from `launch-options`, by id
aurelia play 1245620 -v              # also log progress/debug output (-vv/-vvv: Steam networking)
aurelia play 1245620 --skip-shaders  # Linux: launch without pre-compiling Vulkan shaders first
aurelia shaders 1245620              # Linux: pre-compile a game's Vulkan shaders now (--force to redo)
aurelia running                      # list games Aurelia is currently running
aurelia stop 1245620                 # stop a running game (--force to kill a hung one)

# Steam Cloud
aurelia cloud sync 1245620           # sync saves (down then up)
aurelia cloud list 1245620           # list a game's Cloud files

# Steam Workshop
aurelia workshop browse 1245620            # discover items (search, sort, paginate)
aurelia workshop info 1234567890           # item or collection metadata
aurelia workshop install 1234567890        # download an item (collections expand to members)
aurelia workshop subscribe 1234567890 --install  # subscribe, then download
aurelia workshop status 1245620            # installed vs subscribed (+ update detection)
aurelia workshop rate 1234567890 up        # thumbs-up (or: down) an item
aurelia workshop comments 1234567890       # read an item's comments
aurelia workshop comment 1234567890 "Nice mod!"  # post a comment

# Friends & chat
aurelia friends                              # list friends (name, status, current game)
aurelia friends search "AI Jungle Wulf"      # show a user: SteamID64, /profiles/ URL, friend name or `me`
aurelia friends add 76561197960287930        # send a friend request (same identifiers)
aurelia user me                              # your profile as Steam sees it (no web requests)
aurelia wishlist                             # your wishlist with prices; `wishlist "<friend>"` for a friend's
aurelia wishlist add 1245620                 # add / remove items (`wishlist remove 1245620`)
aurelia friends remove 76561197960287930     # remove a friend or cancel a request
aurelia chat send 76561198042323314 "hi!"    # send a direct message to a friend
aurelia chat history 76561198042323314       # show recent messages with a friend
aurelia chat open 76561198042323314          # interactive live chat (type to send, Ctrl-D quits)

# Inventory & market
aurelia inventory 753 --context 6            # your Steam cards, gems and backgrounds
aurelia market price 440 "Mann Co. Supply Crate Key"   # item price (no login needed)
aurelia market search "Sticker" --app-id 730 # search the Community Market
aurelia market listings                      # your active listings & buy orders
aurelia wallet                               # Steam Wallet balance

# Configuration
aurelia config show                  # print launcher configuration
aurelia config protons               # list detected Proton and Wine runtimes
aurelia config presence online       # appear online for chat (default: invisible)
aurelia config language german       # default language for info and achievements text
aurelia config country DE            # default store region for prices (unset: system locale, else US)
aurelia config game 1245620 --proton GE-Proton9-20  # pin a Proton version for one game
aurelia config install-resume auto   # let the daemon resume interrupted installs when it starts
aurelia config download-limit 50000  # cap all game downloads at 50000 kbit/s (off: no limit, the default)
aurelia config shader-precache off   # Linux: don't pre-compile Vulkan shaders before play (default: auto)
aurelia config hide-uninstalled-launch-options off  # list launch options that aren't installed too (default: on)

# Proton and Wine runtimes (download manager)
aurelia proton list                  # installable runtimes (Valve + GE + CachyOS) and what's installed
aurelia proton install GE-Proton9-20 # download a GE build (or "Proton 9.0" via Steam)
aurelia proton install Proton-CachyOS # CachyOS build (auto-picks x86_64_v3 or AVX2 when supported)
aurelia proton default GE-Proton9-20 # set the global default (used when a game has none set)
aurelia proton uninstall GE-Proton9-19  # delete an installed GE build

# Windows Steam runtime (self-contained Steamworks and DRM handshake, no host Steam client)
aurelia config steam-runtime-runner GE-Proton9-20  # select the Wine or Proton runner (required first)
aurelia steam-runtime status          # resolved master prefix, layout, steam.exe presence
aurelia steam-runtime install         # install Steam into the master Wine prefix (sign in here)
aurelia steam-runtime install --reinstall  # delete the prefix first, then install fresh
                                           # (for a corrupted install, no .bak is kept)
aurelia steam-runtime login           # re-open the in-Wine Steam to sign in again
aurelia steam-runtime repair          # back up the prefix (keep one) and reinstall
aurelia steam-runtime stop            # shut down the in-Wine Steam, keeping the prefix
aurelia steam-runtime uninstall       # remove the master prefix entirely (incl. any .bak)
aurelia config steam-runtime-policy on   # make `play --steam` always use the in-Wine runtime
                                         # (default `auto`: host Steam if present, else in-Wine)

# Collections (library categories): edit locally offline, sync to Steam on demand
aurelia collections list                     # all collections + game counts
aurelia collections create "RPGs"            # new (static) collection
aurelia collections add "RPGs" 570 730       # add games by app id
aurelia collections remove "RPGs" 730        # drop a game
aurelia collections show "RPGs"              # list a collection's games
aurelia list --collection "RPGs"             # filter the library to one collection
aurelia collections pull                     # fetch Steam's collections and merge them in
aurelia collections push --yes               # upload local collections to your Steam account
                                             # (refuses until you've pulled once; --force overrides)
aurelia collections sync --yes               # pull then push (reconcile both sides)

# umu-launcher plugin (Linux only, optional: Proton via umu-run, downloaded on demand)
aurelia umu enable                    # turn the plugin on (off by default)
aurelia umu install                   # download umu-run on demand (not bundled)
aurelia umu path ~/umu                # use an existing install instead (skips the download)
aurelia umu status                    # show enabled state + installed version
aurelia config game 1245620 --umu     # route one game through umu (Proton via umu-run)
aurelia play 1245620 --umu            # one-off launch via umu
aurelia umu uninstall                 # remove the downloaded payload

# Luxtorpeda native-engine plugin (Linux only, optional)
aurelia luxtorpeda enable             # turn the plugin on (off by default)
aurelia luxtorpeda install            # download the client on demand (not bundled)
aurelia luxtorpeda path ~/luxtorpeda  # use an existing install instead (skips the download)
aurelia luxtorpeda status             # show enabled state + installed version
aurelia config game 2270 --native-engine   # route one game through a native engine
aurelia play 2270 --native-engine     # one-off launch via luxtorpeda
aurelia luxtorpeda uninstall          # remove the downloaded payload

# Per-game launch scripts (wrap the resolved launch command with your own script)
aurelia scripts new 2270              # scaffold <script_dir>/2270.sh (2270.bat on Windows)
aurelia scripts list                  # app ids with a script + resolved paths
aurelia scripts show 2270             # print the resolved script + its contents
aurelia play 2270                     # runs through the script (e.g. gamemoderun, mangohud)
aurelia config game 2270 --launch-script ~/my/wrap.sh   # pin a specific script per game
aurelia play 2270 --script ~/other.sh # one-off override for a single launch
aurelia play 2270 --no-script         # bypass all scripts for this launch
aurelia scripts remove 2270           # delete the dir-based script

Note

Luxtorpeda is an optional plugin that runs supported games on native Linux engines (GZDoom, OpenMW, …) instead of Proton or Wine. It is never bundled. Aurelia downloads it on the fly into ~/.config/Aurelia/plugins/luxtorpeda only when you enable the feature and opt a game in, so the binary stays lean. Linux only. Games run outside Steam's runtime container, so if an engine can't find system libraries, prefer Proton for that title.

Note

umu-launcher is an optional plugin that runs Windows games through Proton outside Steam (applying the Steam Linux Runtime and per-game protonfixes), wrapping the launch with umu-run instead of replacing the runtime. Like luxtorpeda it is never bundled. Aurelia downloads it on the fly into ~/.config/Aurelia/plugins/umu only when you enable the feature and opt a game in, so the binary stays lean. Linux only. It wraps Proton rather than replacing it, so --umu combines with --proton to pick the Proton build it runs.

Note

Per-game launch scripts let you wrap the fully-resolved launch command with your own shell script (<script_dir>/<appid>.sh, or .bat on Windows). Aurelia runs the script with the resolved command as its arguments ("$@") and exports AURELIA_* env vars, so a script that is just exec "$@" is a passthrough while a custom one can prepend gamemoderun, mangohud or gamescope. It works uniformly for native, Proton, luxtorpeda and umu launches. Resolution precedence: play --script <path> beats config game --launch-script <path>, which beats the auto-detected <script_dir>/<appid>.sh. play --no-script bypasses all of them.

Add --json to any command for machine-readable output (errors included). It's a global flag, so aurelia --json <command> and aurelia <command> --json are equivalent.

Drivers can feature-detect with aurelia --json capabilities: one line listing the version, the JSON schema number, every command with its flags, arguments and subcommands, all event names, every error type with its exit code and hint, and behaviour features that flags don't reveal. Add a command path (aurelia capabilities config game) for one command's arguments, subcommands and every flag with its short form, value, allowed values and help. It runs offline and never starts the daemon. Every {"event":"result",...} line also carries "schema", which goes up only when an existing field changes meaning or is removed; added fields don't bump it.

login --qr --json streams qr_challenge and qr_scanned events on stderr and ends with exactly one {"event":"result",...} line on stdout. On success a one-line {"logged_in":true,...} object comes just before it. stdin is the driver's control channel: send a cancel line to stop, and keep stdin open while waiting, because EOF ends the login. Outcomes:

type Meaning Exit code
approved Signed in (ok: true, with account and steam_id) 0
login_denied Declined in the app, or the session was dropped by Steam 80
login_expired The code was scanned but not approved before it expired 81
timeout No approval within --timeout (default 600 s) 82
cancelled The driver sent cancel 83
input_closed stdin reached EOF 84

Other failures carry the usual error type (for example network_timeout) and exit code.

install, update and verify stream progress events on stderr. bytes_downloaded includes reused_bytes, the data found intact on disk (a resume or verify), while speed_bps and eta_seconds count network bytes only, averaged over 5 seconds. Install results, backlog changes and QR logins end with a {"event":"result",...} line on stdout.

Two error types apply to every command. disk_full (exit 85): no space or quota left, including install's free-space check before it starts. offline (exit 86): no network route or DNS, or Steam is unreachable and Aurelia is using its cached library. A stopped install (install stop) ends as cancelled (83). aurelia capabilities lists every type with its code.

Logs go to stderr. By default only warnings and errors are shown. -v adds Aurelia's progress and debug logs, and -vv/-vvv unmute the Steam networking stack, which helps when a command seems stuck. Commands run through the session daemon show the same logs at your -v level, and a verbose play also shows the daemon's own activity, prefixed [daemon]. AURELIA_LOG or RUST_LOG override the level for a command run locally. A launched game's own output is saved per launch under ~/.config/Aurelia/logs/ (Proton's stderr in wine_<appid>.log).

The session daemon keeps running until aurelia daemon stop. Set AURELIA_DAEMON_IDLE_TIMEOUT to a number of minutes to let it exit once nothing has used it for that long and no install or game is running. The next command starts a new daemon, which logs on to Steam again.

move, relink and import edit Steam's library files, which a running Steam client overwrites when it exits, so they refuse to run while Steam is open. Add --restart-steam to have Aurelia stop Steam, make the change and start Steam again, even if the change fails.

On Linux, play pre-compiles a game's Vulkan shaders before it starts, like Steam's "Processing Vulkan shaders" step. It replays the game's Steam pipeline cache (steamapps/shadercache/<appid>) with Steam's fossilize_replay and points the NVIDIA, Mesa and DXVK caches at the same folder Steam uses, so the game finds them warm. A replay runs again only when the cache or the graphics driver changed. It needs a pipeline cache (Steam downloads one for most Vulkan and DXVK games) and fossilize_replay (shipped with Steam, or set AURELIA_FOSSILIZE_REPLAY); without them the game simply compiles its shaders as it runs. Skip it once with --skip-shaders, or always with config shader-precache off. A game started through the in-Wine Steam waits up to 5 minutes to appear (--launch-timeout), not counting time that Steam spends processing shaders, and fails with timeout if it never starts.

On Windows, games run natively and the Linux-only parts are switched off: proton install, steam-runtime install|repair|login, and umu/luxtorpeda install refuse with an explanation, and play rejects --proton, --platform linux, --steam-mode runtime, --umu and --native-engine. Use play --steam with your installed Steam client instead.

📖 See the Usage page on the wiki for complete documentation of every command and option.


Configuration

Aurelia stores its configuration and local data under ~/.config/Aurelia (%USERPROFILE%\.config\Aurelia on Windows). Set AURELIA_CONFIG_DIR to relocate it. That is useful for an embedding driver (e.g. Heroic) that needs Aurelia's state isolated from a standalone install. Each config directory gets its own session daemon.

  • Library path. Aurelia auto-detects your existing Steam installation. Inspect the resolved configuration with aurelia config show.
  • Session. Refresh tokens are persisted in session.json so subsequent invocations log in automatically.
  • Download engine. Installs, updates, verifications and Workshop downloads share one engine. It picks the least-loaded content servers, spreads chunk requests over a pool of them, retries a failed chunk on another server, and keeps 16 chunk requests in flight per depot. Set AURELIA_CDN_CONCURRENCY (1–64) to change that, e.g. lower on a shared connection.
  • Install backlog. Unfinished installs are kept in install_backlog.json until they finish or you install forget them. See the installation page on the wiki.

Documentation

Document Contents
Wiki home Index of all documentation
Usage Full reference for every command and flag
Windows Steam Runtime The self-contained Wine Steam prefix (steam-runtime)
Architecture Per-subsystem architectural reference
Releasing How to cut a release and publish binaries
Files Reviewed Manual review checklist for the latest code-review changes
CONTRIBUTING.md How to contribute
SECURITY.md Reporting a vulnerability

FAQ

Is there a Steam client that works without a GUI?

Yes. That is exactly what Aurelia is. It is a pure CLI Steam client: no Electron, no CEF, no embedded browser, no desktop session required. You can log in, install games, update them, sync Cloud saves and launch titles from a terminal or a shell script.

Can I install and play Steam games over SSH or on a headless server?

Yes. Library management, downloads, updates, verification, Cloud sync and Workshop all work headlessly over SSH. Launching a game still needs somewhere for it to render (a display, a virtual X server, or a remote-play setup), but everything up to the launch does not.

How is Aurelia different from SteamCMD?

SteamCMD is Valve's official CLI tool, but it is content-only: it downloads and updates app and Workshop files and little else. Aurelia is a full launcher and library manager. It lists and searches your library, launches games natively or through Proton and Wine, syncs Steam Cloud saves, manages DLC and Workshop subscriptions, reads achievements, and does friends & chat. SteamCMD is proprietary and ships as a prebuilt binary. Aurelia is open source under GPL-3.0-or-later.

Is Aurelia an OpenSteamClient alternative?

It is its spiritual successor. OpenSteamClient is a C++ and Qt desktop GUI. Aurelia rebuilds the same idea in Rust as a scriptable CLI, without the 32-bit legacy Steam binaries, at a fraction of the memory footprint.

Does it run Windows games on Linux?

Yes, through Proton and Wine. Aurelia discovers installed runtimes, downloads new ones (official Valve Proton, GE-Proton, and Proton-CachyOS with AVX2 or x86_64_v3 selection), pins a Proton version per game, and can route launches through umu-launcher or native engines via luxtorpeda.

Do I need the official Steam client installed?

No. Aurelia talks to Steam's real network protocols directly. For titles that insist on a Steamworks or DRM handshake, it can either bridge to a host Steam client if you have one, or install a self-contained Windows Steam runtime inside its own Wine prefix (aurelia steam-runtime install).

How much RAM does it use?

Under ~50 MB idle, against roughly 400 to 800 MB for the official Steam desktop app.

Which platforms are supported?

Linux is the primary target (x86_64 and arm64), and Windows is supported. Releases no longer include macOS binaries. See Install.

Can I use it to script my Steam library?

Yes. Every command accepts --json for machine-readable output, including errors, so Aurelia works as a backend for other launchers and for automation. AURELIA_CONFIG_DIR relocates its state so an embedding driver can keep it isolated.

Is it safe to use? Can I get VAC banned?

Aurelia is unofficial and unaffiliated with Valve, it modifies Steam's files directly, and third-party tools that interact with Steam carry a risk of action against your account. Read the disclaimer at the top of this README before using it. Use at your own risk.


Contributing

Contributions are welcome. See CONTRIBUTING.md for guidelines. By participating, you agree to abide by our Code of Conduct.

Acknowledgments

Aurelia grew directly out of SteamFlow, the earlier project it is derived from and the foundation this work is built on. Our deepest thanks to its author: SteamFlow did the hard groundwork that made Aurelia possible.

It stands, in turn, on steam-vent and steam-vent-chat, whose reverse-engineering and protocol work let Aurelia speak Steam's real network protocols, and on a modified fork of steam-cdn (plus the zip crate) for the content pipeline.

Credits


Star History

Star History Chart

Related projects

  • SteamCMD: Valve's official, content-only command-line tool
  • OpenSteamClient: open-source C++ and Qt Steam client. Aurelia is its Rust CLI successor
  • SteamFlow: the project Aurelia is derived from
  • steam-vent: the Steam network protocol implementation Aurelia is built on
  • Heroic Games Launcher: GUI launcher that can drive Aurelia for its Steam integration
  • umu-launcher: optional launch plugin that runs Proton outside Steam
  • luxtorpeda: optional launch plugin for native Linux engines

Topics: steam client cli, headless steam, steam launcher linux, steamcmd alternative, open source steam client, terminal steam, install steam games from command line, proton launcher cli, steam library manager, rust steam client.


License

Aurelia is released under the GPL-3.0-or-later License.

About

Headless command-line Steam client for Linux and Windows, written in Rust. Install, update and launch Steam games (native or Proton/Wine) from the terminal, plus Steam Cloud saves, Workshop, DLC, collections and friends & chat. An open-source SteamCMD and OpenSteamClient alternative, scriptable with --json.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

125 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages