PolyFi: Ranked Documentation

PolyFi: Ranked is a Windows application that automatically connects to the highest-priority available Wi-Fi network from your configured preference list.

Getting Started

• Quick Start (from Source)
  • Prerequisites
  • Basic Install and Run
  • One-Shot Setup Script
  • Pointing PolyFi at a Custom App-Data Root
  • Teardown
  • Purge All PolyFi Traces
  • Default File Paths
• Getting Started: Windows Installer
  • Prerequisites
  • Downloading the Installer
  • Running the Installer Wizard
  • First Launch
  • Configuring Your Wi-Fi Networks
  • Default File Paths
  • Running in Tray Mode
  • Windows Startup Integration
  • Update Checks
  • Uninstalling

Usage

• CLI Reference
  • Top-Level Flags
  • paths Command
  • config Commands
  • windows Commands
  • Task Scheduler Entry Points
• Runtime Features
  • Tray Mode
  • Live Config Reload
  • Ethernet-Aware Wi-Fi Mode
  • Speed Tests
  • Windows Startup Integration
  • Update Checks
  • Startup Splash Screen
  • Notes

Configuration & Reference

• Configuration Guide
  • Configuration Layout
  • Example
  • How PolyFi Uses It
  • Practical Notes
• Config Reference
  • [general] Settings
  • [[networks]] Entries
  • Example Network List

AutoAPI

• API Reference
  • Package
  • Configuration and Models
  • Runtime Services
  • Windows Integration

Development & Packaging

• Development
  • Setting Up the Contributor Environment
  • Running Tests
  • GUI Development Notes
  • Building Sphinx Documentation
  • Windows Packaging
  • GitHub Releases
  • Release Hygiene
• Building the Windows Installer
  • Prerequisites
  • Installing Packaging Dependencies
  • Building with the PowerShell Script
  • Building with the Python Driver Directly
  • Output Locations
  • How Inno Setup Is Located
  • CI and Release Builds
  • Troubleshooting

Wiki

• PolyFi: Ranked
  • Pages
• CLI Reference
  • Table of Contents
  • Quick Start
  • Top-Level Flags
  • paths
  • config
  • config init
  • windows
  • windows start-menu install
  • windows startup install
  • windows logon-task install
  • windows uninstall
  • Task Scheduler Entry Points
  • polyfi-ranked-install-task
  • Reference Links
• Contributing Docs