Quick Start Your Project with the Ledger VS Code Extension

The Ledger VS Code extension gives you a fast, self-contained environment for building and testing apps for Ledger devices. It uses Ledger’s own Docker image so your environment is ready in minutes.

What the extension includes

• Build your app for all Ledger devices. Supports C and Rust apps.
• Run functional tests on the device emulator (Speculos) or on a real device.
• Load and delete apps on a physical device.
• Run AI-powered code reviews using Ledger’s own agent instructions.
• Run development guidelines checks to verify your app is ready for deployment.
• Stay up to date with the latest SDK.
• Support multiple app folders in the same workspace, each with its own Docker container.
• Inspect what the extension executes directly in VS Code’s terminal panels.

Prerequisites

• Docker installed and running
• An X Window System server:
  • Linux: running by default
  • macOS: install and launch XQuartz
  • Windows: install and launch VcXsrv
  • On macOS and Windows, make sure client connections are allowed in the X server settings.
• Visual Studio Code
• The Ledger VS Code extension
• One of: C App Boilerplate, Rust App Boilerplate, or Plugin Boilerplate

Using the extension

All features are accessible through the sidebar webview. Use the toolbar inside the webview to pin the actions you use most. You can also trigger build and test tasks directly from the VS Code task menu with Ctrl+Shift+B (Cmd+Shift+B on macOS), without opening the sidebar.

The status bar shows two quick indicators at the bottom of the editor:

• The device you are currently building for.
• The status of the Ledger developer tools Docker image.

Build and load your app

1. Start Docker and your X server.
2. Open a boilerplate app in VS Code.
3. Select your target device in the sidebar.
4. Click Build app to compile.
5. Click Load app on device to sideload onto a connected device. Note that sideloading is not available on Nano X.

Functional tests

Run functional tests against the Speculos emulator or on a real device directly from the sidebar. See the testing requirements for details.

Device operations

The extension supports a quick device setup that skips the standard onboarding by assigning a generic seed and PIN defined in the extension settings. This seed is for testing only — use the seed generated by your device for any real-world use, and factory reset your device after testing.

You can also load and delete apps on a connected device from the sidebar.

AI Review

The extension can run an AI-powered code review of your app using Ledger’s agent instructions. Select the model that matches your Copilot subscription and review needs, then trigger the review from the sidebar.

You are now set up to build, test, and review a Ledger app. Modify the boilerplate to fit your project’s requirements.