Clone this repo:
  1. b3d1a20 [third_party/pigweed] Roll 5 commits by pigweed-roller · 2 days ago main
  2. 3c4397d [roll third_party/pigweed] emboss: Loosen Emboss cmake dependency tracking by Eric Rahm · 2 days ago
  3. 7c7f508 [third_party/pigweed] Roll 2 commits by pigweed-roller · 3 days ago
  4. 2b42d5d [third_party/pigweed] Roll 3 commits by pigweed-roller · 3 days ago
  5. e4d1b3f [roll third_party/pigweed] pw_sensor: Add module stub by Yuval Peress · 3 days ago

Pigweed Sample Project

This repository outlines the recommended way of using Pigweed in a new or existing project. Feel free to fork this repository, or read it as a reference.

For more information see the Pigweed Getting started guide.

Check back for more complex examples and features coming soon!

Getting started

Make sure you've set up Pigweed's prerequisites.

If you're on Windows, you can automate the initial setup by downloading the first-time setup script from cmd.exe:

curl > setup_pigweed_prerequisites.b64 && certutil -decode -f setup_pigweed_prerequisites.b64 setup_pigweed_prerequisites.bat && del setup_pigweed_prerequisites.b64

Then you can run the script with the following command in cmd.exe:


Note: You may see a few UAC prompts as the script installs Git, Python, and enables developer mode.

Once that is done, you can clone this project with the following command:

git clone

Environment setup

Pigweed uses a local development environment for most of its tools. This means tools are not installed to your machine, and are instead stored in a directory inside your project (Note: git ignores this directory). The tools are temporarily added to the PATH of the current shell session.

To make sure the latest tooling has been fetched and set up, run the bootstrap command for your operating system:



Linux & Mac

source ./

After tooling updates, you might need to run bootstrap again to ensure the latest tools.

After the initial bootstrap, you can use use the activate scripts to configure the current shell for development without doing a full update.



Linux & Mac

source ./


All of these commands must be run from inside an activated developer environment. See Environment setup

One-shot build

To build the project, documentation, and tests, run the following command in an activated environment:

pw build

Automatically build on file save

Alternatively, if you'd like an automatic rebuild to trigger whenever you save changes to files, use pw watch:

pw watch

Typical workflow

When you pull latest repository changes, run bootstrap:

source ./

If you're just launching a new shell session, you can activate instead:

source ./

and rebuild with:

pw build

More info and Examples

Extended documentation and examples are built along code changes. You can view them at out/gn/docs/gen/docs/html/index.html.