wfcli

Warframe toolkit for terminal, desktop, MCP, and Linux/Proton in-game use. A shared Erlang/OTP daemon owns fetching, caches, queries, watches, player data, Market access, and Forma planning. Clients remain focused on their interface.

Applications

Application	Purpose
wfcli	Terminal client, daemon controls, and stdio MCP entrypoint
wfdaemon	Supervised data, persistence, query, market, watch, and planning service
wfcompanion	Linux/Proton game observer and Wayland overlay
wfgui	Native Qt desktop client for account and world-state views
wfcore	Process-free contracts and value helpers shared by OTP applications

Clients start wfdaemon when needed. Concurrent clients reuse its caches and rate-limited work.

Desktop GUI

wfgui provides Foundry, Mastery Helper, Inventory, Relic Planner, and Market views alongside live world timers and fissures.

In-game Overlays

wfcompanion augments relic rewards with Market values and collection progress, then ranks owned relics during selection.

Install

The Homebrew package targets Linux x86_64. Add the tap, trust only the wfcli formula, and install it:

brew tap zeewanderer/sundries
brew trust --formula zeewanderer/sundries/wfcli
brew install wfcli

This installs wfcli, wfdaemon, wfcompanion, and wfgui into Homebrew's command path.

Steam launch mode

Find the installed companion:

command -v wfcompanion

Set Warframe > Properties > General > Launch Options in Steam using that absolute path:

/absolute/path/to/wfcompanion launch -- %command%

Start wfdaemon from the host before launching Warframe; Proton-side startup is not recommended:

wfcli daemon ensure

Launch mode starts the companion with Warframe and reuses wfdaemon. See the companion guide for automatic Steam configuration and overlay controls.

Desktop launcher

Register the GUI in the desktop application menu and install its notification identity:

wfcli gui install

Daemon service (optional)

Normal CLI, GUI, and companion use starts wfdaemon automatically. Enable login autostart only when persistent watches or notifications should remain active without an open client:

wfcli daemon autostart enable

Homebrew installations manage this through brew services; use wfcli daemon autostart status to inspect it.

Build

Required toolchains:

Area	Requirements
Common	Git, GNU Make, CMake, and a C/C++ compiler
Erlang	Erlang/OTP 29 and Rebar3
Companion	Rust, Cargo, jq, and MinGW-w64
Desktop GUI	LLVM with libc++, Ninja, vcpkg, Autoconf, Autoconf Archive, Automake, and Libtool

wfcompanion runtime integration requires KDE Plasma on Wayland, KScreen, and Tesseract 5 with English language data. sccache is optional. FFmpeg with VP9 support is used for animated overlay previews, and zip is used for release archives.

Initialize dependencies and build development and production trees:

git submodule update --init
export VCPKG_ROOT=/path/to/vcpkg
make build

Build one environment:

make dev   # debug builds in dev/
make prod  # optimized builds in prod/

Compiler output stays under _build/; downloads and compiler caches stay under .cache/. Repository-root links select either staged environment:

Development	Production
wfclid	wfcli
wfdaemond	wfdaemon
wfcompaniond	wfcompanion
wfguid	wfgui

Common contributor commands and individual build targets are documented in Development workflows.

Run

Use installed commands, or the production links after make prod:

wfcli fissures
wfcli baro inventory
wfcli query 'dataset=worldstate type=fissure hard=true'
wfgui

The CLI starts or reuses wfdaemon. Built-in help covers the complete command surface:

wfcli --help
wfcli help commands
wfcli COMMAND --help

Register the MCP adapter with a host using the same production client:

codex mcp add wfcli -- wfcli mcp

Documentation

Guide	Contents
Command-line client	Command groups, help, completion, paths, and notifications
Query language and watches	Datasets, expressions, raw paths, sorting, paging, and subscriptions
Data sources and updates	Provenance, managed caches, and refresh behavior
Forma planner	Configuration, constraints, output, and visualization
Daemon control	Lifecycle, idle policy, autostart, compatibility, and hot updates
Linux/Proton companion	Steam setup, overlay controls, diagnostics, previews, and player data
Desktop GUI	Pages, loading behavior, notifications, and screenshots
MCP server	Registration, tools, resources, and cancellation
Contributor documentation	Architecture, source ownership, tests, and development workflows

License

Project code is licensed under Apache-2.0; see LICENSE.md. Third-party components and Digital Extremes assets retain their own terms. Warframe assets are used under the Warframe Content Policy; provenance notes live beside the relevant files.