<div align="center">

PicoForge

<img src="static/appIcons/in.suyogtandel.picoforge.svg" width="512" height="512" alt="PicoForge Logo">

An open source commissioning tool for Pico FIDO security keys

</div>

[!IMPORTANT] PicoForge is an independent, community-developed tool and is not affiliated with or endorsed by the official pico-fido project. This software does not share any code with the official closed-source pico-fido application.

Check application Installation Wiki for installation guide of the PicoForge app on your system.

PicoForge only supports v7.2 of the PICO FIDO series of firmwares. Support to v7.4 and above is WIP.

About

PicoForge is a modern desktop application for configuring and managing Pico FIDO security keys. Built with Rust and GPUI, it provides an intuitive interface for:

• Reading device information and firmware details
• Configuring USB VID/PID and product names
• Adjusting LED settings (GPIO, brightness, driver)
• Managing security features (secure boot, firmware locking) (WIP)
• Real-time system logging and diagnostics
• Support for multiple hardware variants and vendors

BETA Status: This application is currently under active development and in beta stage. Users should expect bugs and are encouraged to report them. The app has been tested on Linux and Windows 10 with the official Raspberry Pi Pico2 & ESP32-S3 and, currently supports Pico FIDO firmware version 7.2 only.

Screenshots

<div align="center">

Main Interface

PassKeys Management

Configuration Interface

</div>

Features

• Device Configuration - Customize USB identifiers, LED behavior, and hardware settings
• Security Management - Enable secure boot and firmware verification (experimental and WIP)
• Real-time Monitoring - View flash usage, connection status, and system logs
• Modern UI - Clean, responsive interface built with Rust and GPUI
• Multi-Vendor Support - Compatible with multiple hardware variants
• Cross-Platform - Works on Windows, macOS, and Linux

Installation

Linux:

Other OS:

Check the official PicoForge Wiki for installation info of the application.

Usage

1. Connect your smart card reader
2. Insert your Pico FIDO device
3. Launch PicoForge
4. Click Refresh button at top right corner to detect your key
5. Navigate through the sidebar to configure settings:
   • Home - Device overview and quick actions
   • Configuration - USB settings, LED options
   • Security - Secure boot management (experimental)
   • Logs - Real-time event monitoring
   • About - Application information

Requirements

Development Requirements

To contribute to PicoForge, you'll need:

• Rust - System programming language (1.80+)
• PC/SC Middleware:
  • Linux: pcscd (usually pre-installed)
  • macOS: Built-in
  • Windows: Built-in

Building from Source

1. Clone the Repository

git clone https://github.com/librekeys/picoforge.git
cd picoforge

2. Build and Run

To run the application in development mode:

cargo run

To build for production:

cargo build --release

The compiled binary will be available in target/release/picoforge (Linux/macOS) or target/release/picoforge.exe (Windows).

Building and Development with Nix

Nix provides developers with a complete and consistent development environment.

You can use Nix to build and develop picoforge painlessly.

1. Install Nix

Follow the Installation Guide and NixOS Wiki to install Nix and enable Flakes.

2. Build & Run

a. with Flakes

You can build and run PicoForge with a single command:

nix run github:librekeys/picoforge

Or simply build it and link to the current directory:

nix build github:librekeys/picoforge

[!TIP] You can use our binary cache to save build time by allowing Nix to set extra-substitutes.

b. without Flakes

Download the package definition:

curl -LO https://raw.githubusercontent.com/librekeys/picoforge/main/package.nix

Run the following command in the directory containing package.nix:

nix-build -E 'with import <nixpkgs> {}; callPackage ./package.nix { }'

The compiled binary will be available at: result/bin/picoforge

3. Develop

You can enter a developement environement with all the required dependencies.

a. with Flakes

nix develop github:librekeys/picoforge

b. without Flakes

You can use the shell.nix file that is at the root of the repository by running:

nix-shell

Then you can build from source and run the application with:

cargo run

Project Structure

picoforge/
├── Cargo.toml                              # Rust dependencies and project metadata
├── Cargo.lock                              # Rust dependency lock file
├── Packager.toml                           # Configuration for cargo-packager
├── src/                                    # Source code
│   ├── main.rs                             # Application entry point
│   ├── logging.rs                          # Logging infrastructure
│   ├── error.rs                            # Global application error types
│   ├── device/                             # Device communication logic
│   │   ├── fido/                           # FIDO implementation
│   │   ├── rescue/                         # Rescue mode handling
│   │   ├── io.rs                           # IO Utilities
│   │   ├── mod.rs                          # Device module declaration
│   │   └── types.rs                        # Device data types
│   └── ui/                                 # GPUI Frontend
│       ├── components/                     # Reusable UI components
│       ├── views/                          # View definitions
│       ├── assets.rs                       # Asset loader
│       ├── colors.rs                       # Color definitions
│       ├── rootview.rs                     # Root view container
│       ├── types.rs                        # UI-specific types
│       └── mod.rs                          # UI module declaration
├── data/                                   # Application data
│   ├── in.suyogtandel.picoforge.desktop    # Linux desktop entry file
│   └── screenshots/                        # Screenshots for documentation
├── docs/                                   # Project documentation/wiki files
│   ├── Building.md                         # Instructions for building from source
│   ├── Home.md                             # Wiki home page
│   ├── Installation.md                     # Installation guide
│   └── Troubleshooting.md                  # Troubleshooting common issues
├── maintainers/                            # Scripts and resources for package maintainers
│   └── scripts/                            # Utility scripts for automating maintenance tasks
│       ├── update.nix                      # Nix update script configuration
│       └── update.py                       # Update script implementation
├── static/                                 # Static application assets
│   ├── appIcons/                           # App icons in various sizes and formats
│   └── icons/                              # Internal SVG icons used by the GPUI frontend
├── themes/                                 # Application themes
│   └── picoforge-zinc.json                 # Zinc theme configuration file
├── flake.nix                               # Nix flake configuration
├── flake.lock                              # Nix flake lock file
├── default.nix                             # Nix package definition/shell
├── shell.nix                               # Nix development shell
├── picoforge.spec                          # RPM Spec file
├── package.nix                             # Nix package definition
├── ci.nix                                  # CI configuration for cachix
├── rustfmt.toml                            # Rust formatting configuration
├── CREDITS.md                              # Credits
└── LICENSE                                 # License

Contributing

Contributions are welcome (REALLY NEEDED, PLEASE HELP US)!

Please check the CONTRIBUTING.md file for the full contribution process and development guidelines.

License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0-only).

See LICENSE for full details.

Repository Maintainers

• Suyog Tandel (@lockedmutex)
• Fabrice Bellamy ([@Lab-8916100448256]