cargo build --workspace
cargo test --workspace
cargo clippy --workspace --all-targets -- -D warnings
cargo fmt --allcargo run starts the daemon (the default member); pass --workspace to build or test
everything. Running a build covers trying one without installing it.
Aliases in .cargo/config.toml:
| Alias | Runs | Does |
|---|---|---|
cargo release |
cargo build --release --workspace |
builds Tile.exe in release |
cargo deploy |
cargo run --release -p tile -- install |
installs the build from cargo release |
cargo deploy-dev |
cargo run -p tile -- install |
installs the debug build from cargo build --workspace |
scripts/send-test-toast.ps1 posts a real Windows toast notification as an installed app (for
testing notification popups, including their icon). Run
it with Windows PowerShell (powershell), not PowerShell 7, which can't load the WinRT types it
needs.
cargo release # builds Tile.exe in release
cargo deploy # installs and starts it (one UAC prompt)
cargo run --release # runs it without installing
. arget
elease\Tile.exe -c my.yml # runs it with another config fileTo update an install from a checkout, run cargo release and cargo deploy again, or
tile install from the checkout: the installed tile installs the build in . arget elease.
Releases also carry Tile-Setup-<version>.exe, built from installer/tile.iss (Inno Setup),
which runs tile install and adds Tile to Apps & features, where Uninstall runs tile uninstall.
| Crate | Purpose |
|---|---|
tile-core |
Platform-independent window manager model: state, one state per virtual desktop, layouts with their defaults and limits, dispatchers, geometry and easing (unit tested) |
tile-remap |
The key remapper: layers and overloads as a pure state machine, its config parser and the key names shared with keybinds (unit tested) |
tile-config |
YAML schema, keybind parsing, window rules, the feature switches and file watching (tested against docs/ and examples/) |
tile-ipc |
Named-pipe JSON protocol |
tile-launcher |
The app launcher: the search, calculator and system items (tested), and its window |
tile-platform |
Win32 for the window manager: window events, placement and animation, the keybind hook, the Win+drag mouse hook, tray, the workspace indicator, the sign-in shell and programs, virtual desktops, Win+L and Click to Do, the current user's registry values and where Tile is installed |
tile-input |
The low-level keyboard and mouse hooks, SendInput and hiding the pointer |
tile-shell |
What Explorer provides, for shell mode: the notification area host (Shell_TrayWnd), the desktop backdrop (colour or wallpaper), shell icons and the Store app frames |
tile-sys |
Volume, audio devices, battery, network, Wi-Fi and Bluetooth, the single-instance mutex, the console, starting detached processes, window messages and safe handles for raw window handles |
tile |
The program (Tile.exe): the daemon, the command line, install/uninstall and its scheduled task |
The crates layer upward: tile-core, tile-remap and tile-config know nothing of Windows;
tile-input, tile-shell and tile-sys are the raw Win32 calls; tile-platform and
tile-launcher build on them; tile joins everything in the daemon.
All unsafe lives in tile-input, tile-shell and tile-sys, each block with a // SAFETY:
comment; every other crate has unsafe_code = "forbid". Every crate warns on missing_docs, so
CI fails on a public item without a doc comment. The rest of Win32 goes through safe
wrappers:
winsafe,
wineventhook,
uiautomation,
tray-icon and
winvd.
The low-level crates call flat Win32 through
windows-sys and COM and WinRT through
windows. The undocumented shell interfaces (the Store app
frame manager, the audio policy) are declared with windows' #[interface] macro, with
placeholder methods holding the slots before the ones called. winvd still takes windows 0.58,
so the workspace keeps that version as windows-winvd, used only for its HWND type.
tile-core holds the whole model: State owns monitors, workspaces and window membership, and
every change returns a list of effects (place, show, hide, focus, close, exec) for the daemon to
apply. That keeps the layouts and dispatchers testable without Windows.
Every pull request runs the CI workflow: yamllint --strict . (rules in .yamllint.yml),
cargo fmt --check, clippy with warnings denied, and the tests, the same checks as
AGENTS.md. Pushes to main run them in the Release workflow, before it builds.
Every push to main that changes more than docs and examples runs the Release workflow, which tests, builds
and publishes a GitHub release holding Tile.exe. No
tag is pushed: the version is the major and minor from Cargo.toml, with the workflow run number
as the patch (0.1.7), and the release creates its own tag. To release by hand, run it from the
Actions tab or with gh workflow run release.yml. Bump the major or minor in Cargo.toml for a
bigger release.
The docs change with the code; AGENTS.md lists what goes where
and the tests that keep docs/configuration.md and examples/default.yml in step with the
defaults.
Win+ right-drag to resize a window in the direction the mouse moves, pushing the neighbouring tiles along.