https://github.com/fpgawars/apio
:seedling: Open source ecosystem for open FPGA boards
https://github.com/fpgawars/apio
apio cli fpga icestorm lattice manager package python verilog
Last synced: 2 days ago
JSON representation
:seedling: Open source ecosystem for open FPGA boards
- Host: GitHub
- URL: https://github.com/fpgawars/apio
- Owner: FPGAwars
- License: gpl-3.0
- Created: 2016-02-09T11:09:15.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2026-01-17T01:55:47.000Z (8 days ago)
- Last Synced: 2026-01-17T07:01:38.942Z (8 days ago)
- Topics: apio, cli, fpga, icestorm, lattice, manager, package, python, verilog
- Language: Python
- Homepage: https://github.com/FPGAwars/apio/wiki
- Size: 155 MB
- Stars: 945
- Watchers: 34
- Forks: 153
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing-definitions.md
- License: LICENSE
- Support: docs/supported-boards.md
Awesome Lists containing this project
README
[](https://github.com/FPGAwars/apio/blob/main/LICENSE)
[](https://pypi.org/project/apio)
   
[](https://github.com/fpgawars/apio/actions/workflows/test.yaml)
[](https://github.com/fpgawars/apio/actions/workflows/build-pre-release.yaml)
[](https://github.com/fpgawars/apio/actions/workflows/publish-docs.yaml)
[](https://github.com/fpgawars/apio/actions/workflows/monitor-apio-pypi.yaml)
[](https://github.com/fpgawars/apio/actions/workflows/monitor-apio-latest.yaml)
[](https://github.com/fpgawars/apio-vscode/actions/workflows/test.yaml)
[](https://github.com/fpgawars/apio-vscode/actions/workflows/build-pre-release.yaml)
[](https://github.com/fpgawars/apio-examples/actions/workflows/test.yaml)
[](https://github.com/fpgawars/apio-examples/actions/workflows/build-pre-release.yaml)
[](https://github.com/fpgawars/apio-definitions/actions/workflows/test.yaml)
[](https://github.com/fpgawars/apio-definitions/actions/workflows/build-pre-release.yaml)
[](https://github.com/fpgawars/tools-oss-cad-suite/actions/workflows/build-pre-release.yaml)
[](https://github.com/fpgawars/tools-verible/actions/workflows/build-pre-release.yaml)
[](https://github.com/fpgawars/tools-graphviz/actions/workflows/build-pre-release.yaml)
[](https://github.com/fpgawars/tools-drivers/actions/workflows/build-pre-release.yaml)
[](https://github.com/fpgawars/apio-workflows/actions/workflows/test.yaml)
[](https://github.com/fpgawars/apio-workflows/actions/workflows/backup-apio-repos.yaml)
---
Apio CLI is an easy to install and use command-line tool for FPGA design from A to Z. For a quick start, visit the [Getting started with Apio](https://fpgawars.github.io/apio/docs/quick-start) guide.
Simulation example:
## Description
Apio CLI is a powerful yet easy-to-use command line tool for FPGA development using Verilog and System Verilog. It’s simple to install, no toolchains, licenses, or makefiles required, and works across Linux, Windows, and macOS. Apio CLI is 100% open source, and free to use.
Apio CLI supports every stage of the FPGA workflow, from simulating and testing, to building and programming the FPGA, using simple commands such as `apio test`, `apio build`, and `apio upload` that do what you expect them to do.
Apio CLI currently supports over 80 FPGA boards, custom boards can be easily added, and it includes over 60 ready-to-use example projects. Apio CLI currently supports the ICE40, ECP5, and GOWIN FPGA architectures.
## Sample Apio CLI session
1. `apio examples fetch alhambra-ii/getting-started` - fetch an example.
2. `apio build` - build the project.
3. `apio report` - report utilization and max clock speed.
4. `apio sim` - simulate the design and show signals.
5. `apio upload` - program the FPGA board.
## Apio CLI in the media
[Shawn Hymel's](https://shawnhymel.com/) excellent series on FPGA programming is based on and older version of **Apio CLI** and the the Icestick board
[](https://www.youtube.com/watch?v=lLg1AgA2Xoo&list=PLEBQazB0HUyT1WmMONxRZn9NmQ_9CIKhb)
As the user **gh02t** said in this post on [Hacker-news](https://news.ycombinator.com/item?id=17912510):
> Apio is a command-line tool that automates installing the toolchain for your FPGA and running it. It just simplifies things, you don't have to use it if you'd rather call the individual tools for synthesis, P&R, simulation etc. It'd be reasonable to think of it as akin to a very smart Makefile combined with an automatic package manager, specialized to FPGAs (it's based on PlatformIO). It's nice when you're still kind of getting oriented, because you don't need to know how to set up and invoke the different tools... just call `apio build` or `apio sim`
## Resources
- [Apio CLI Documentation](https://fpgawars.github.io/apio/docs/)
- [Getting started with Apio](https://fpgawars.github.io/apio/docs/quick-start)
- [Apio CLI github repository](https://github.com/fpgawars/apio)
- [Apio CLI package on PyPi](https://pypi.org/project/apio/)
- [Apio CLI development environment](https://fpgawars.github.io/apio/docs/development-environment/) (for Apio CLI developers).
- [Apio CLI daily build](https://github.com/fpgawars/apio/releases)
- [Apio CLI Test Coverage Report](https://fpgawars.github.io/apio/coverage/)
## Credits
- Apio CLI was inspired by [PlatformIO](https://github.com/platformio/platformio) and was originally created by [Jesús Arroyo Torrens](https://github.com/Jesus89) in February 2016.
- Thanks to all the Apio CLI [contributors](https://github.com/FPGAwars/apio/graphs/contributors) over the years.
- Apio CLI uses open source tools including [Yosys](https://www.yosyshq.com), [Click](https://pypi.org/project/click), [Scons](https://pypi.org/project/SCons), [GTKWave](https://gtkwave.sourceforge.net), and [Python](https://www.python.org/downloads).
- [BQ](https://www.bq.com) sponsored this project from 02/2016 to 11/2016. Thanks.
## License
The Apio project itself is licensed under the GNU General Public License version 3.0 (GPL-3.0).
Pre-built packages may include third-party tools and components, which are subject to their
respective license terms.