{"id":18411060,"url":"https://github.com/fpgawars/apio","last_synced_at":"2026-04-26T05:01:03.129Z","repository":{"id":4237236,"uuid":"51361989","full_name":"FPGAwars/apio","owner":"FPGAwars","description":":seedling: Open source ecosystem for open FPGA boards","archived":false,"fork":false,"pushed_at":"2026-04-23T02:53:59.000Z","size":163058,"stargazers_count":971,"open_issues_count":32,"forks_count":155,"subscribers_count":34,"default_branch":"main","last_synced_at":"2026-04-23T04:23:56.802Z","etag":null,"topics":["apio","cli","fpga","icestorm","lattice","manager","package","python","verilog"],"latest_commit_sha":null,"homepage":"https://github.com/FPGAwars/apio/wiki","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FPGAwars.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing-definitions.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"docs/supported-boards.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-02-09T11:09:15.000Z","updated_at":"2026-04-22T20:01:20.000Z","dependencies_parsed_at":"2026-03-11T04:02:05.192Z","dependency_job_id":"3c76b420-8d21-4ba7-9604-6c5cac07ba75","html_url":"https://github.com/FPGAwars/apio","commit_stats":{"total_commits":1700,"total_committers":52,"mean_commits":32.69230769230769,"dds":0.6105882352941177,"last_synced_commit":"523a7e44dedab926699b6105b15a235d11e08f0f"},"previous_names":[],"tags_count":168,"template":false,"template_full_name":null,"purl":"pkg:github/FPGAwars/apio","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FPGAwars%2Fapio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FPGAwars%2Fapio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FPGAwars%2Fapio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FPGAwars%2Fapio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FPGAwars","download_url":"https://codeload.github.com/FPGAwars/apio/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FPGAwars%2Fapio/sbom","scorecard":{"id":48668,"data":{"date":"2025-08-11","repo":{"name":"github.com/FPGAwars/apio","commit":"ecc790ede07627d3bce0385d3af9a1032ea74233"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.9,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 30 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/monitor-apio-latest.yaml:1","Warn: no topLevel permission defined: .github/workflows/monitor-apio-prod.yaml:1","Warn: topLevel 'contents' permission set to 'write': .github/workflows/publish-mkdocs-docs.yaml:23","Warn: no topLevel permission defined: .github/workflows/publish-to-pypi.yaml:1","Warn: no topLevel permission defined: .github/workflows/test.yaml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/monitor-apio-latest.yaml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/FPGAwars/apio/monitor-apio-latest.yaml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/monitor-apio-prod.yaml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/FPGAwars/apio/monitor-apio-prod.yaml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-mkdocs-docs.yaml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/FPGAwars/apio/publish-mkdocs-docs.yaml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-mkdocs-docs.yaml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/FPGAwars/apio/publish-mkdocs-docs.yaml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-to-pypi.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/FPGAwars/apio/publish-to-pypi.yaml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-to-pypi.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/FPGAwars/apio/publish-to-pypi.yaml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/FPGAwars/apio/test.yaml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/FPGAwars/apio/test.yaml/develop?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/monitor-apio-latest.yaml:50","Warn: pipCommand not pinned by hash: .github/workflows/monitor-apio-prod.yaml:47","Warn: pipCommand not pinned by hash: .github/workflows/publish-mkdocs-docs.yaml:40","Warn: pipCommand not pinned by hash: .github/workflows/publish-mkdocs-docs.yaml:41","Warn: pipCommand not pinned by hash: .github/workflows/test.yaml:90","Info:   0 out of   8 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   5 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-14T23:17:11.645Z","repository_id":4237236,"created_at":"2025-08-14T23:17:11.645Z","updated_at":"2025-08-14T23:17:11.645Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32286271,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-25T18:29:39.964Z","status":"online","status_checked_at":"2026-04-26T02:00:05.962Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apio","cli","fpga","icestorm","lattice","manager","package","python","verilog"],"created_at":"2024-11-06T03:35:03.919Z","updated_at":"2026-04-26T05:01:03.109Z","avatar_url":"https://github.com/FPGAwars.png","language":"Python","readme":"\u003c!--\nThis README page is optimized for its appearance in the github repo rather than for the PyPi listing.\n--\u003e\n\n\u003c!-- Page banner --\u003e\n![apio-cli-banner](https://raw.githubusercontent.com/zapta/apio/main/media/apio-cli-banner.png)\n\n\u003c!-- Attributes badges --\u003e\n[![license](https://img.shields.io/badge/License-GPL%203.0-blue.svg)](https://github.com/FPGAwars/apio/blob/main/LICENSE)\n[![python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)](https://pypi.org/project/apio)\n\n\u003c!-- Platforms badges --\u003e\n![linux](https://raw.githubusercontent.com/zapta/apio/main/media/linux-logo.png)\u0026nbsp;\u0026nbsp;\u0026nbsp;![macos](https://raw.githubusercontent.com/zapta/apio/main/media/macosx-logo.png)\u0026nbsp;\u0026nbsp;\u0026nbsp;![windows](https://raw.githubusercontent.com/zapta/apio/main/media/windows-logo.png)\u0026nbsp;\u0026nbsp;\u0026nbsp;![raspberry-pi](https://raw.githubusercontent.com/zapta/apio/main/media/raspbian-logo.png)\n\n\u003c!-- Status badges --\u003e\n[![cli-test](https://img.shields.io/github/actions/workflow/status/fpgawars/apio/test.yaml?label=cli-test)](https://github.com/fpgawars/apio/actions/workflows/test.yaml)\n[![cli-build](https://img.shields.io/github/actions/workflow/status/fpgawars/apio/build-pre-release.yaml?label=cli-build)](https://github.com/fpgawars/apio/actions/workflows/build-pre-release.yaml)\n[![cli-docs](https://img.shields.io/github/actions/workflow/status/fpgawars/apio/publish-docs.yaml?label=cli-docs)](https://github.com/fpgawars/apio/actions/workflows/publish-docs.yaml)\n[![cli-pypi-monitor](https://img.shields.io/github/actions/workflow/status/fpgawars/apio/monitor-apio-pypi.yaml?label=cli-pypi-monitor)](https://github.com/fpgawars/apio/actions/workflows/monitor-apio-pypi.yaml)\n[![cli-latest-monitor](https://img.shields.io/github/actions/workflow/status/fpgawars/apio/monitor-apio-latest.yaml?label=cli-latest-monitor)](https://github.com/fpgawars/apio/actions/workflows/monitor-apio-latest.yaml)\n[![ide-test](https://img.shields.io/github/actions/workflow/status/fpgawars/apio-vscode/test.yaml?label=ide-test)](https://github.com/fpgawars/apio-vscode/actions/workflows/test.yaml)\n[![ide-build](https://img.shields.io/github/actions/workflow/status/fpgawars/apio-vscode/build-pre-release.yaml?label=ide-build)](https://github.com/fpgawars/apio-vscode/actions/workflows/build-pre-release.yaml)\n[![examples-test](https://img.shields.io/github/actions/workflow/status/fpgawars/apio-examples/test.yaml?label=examples-test)](https://github.com/fpgawars/apio-examples/actions/workflows/test.yaml)\n[![examples-build](https://img.shields.io/github/actions/workflow/status/fpgawars/apio-examples/build-pre-release.yaml?label=examples-build)](https://github.com/fpgawars/apio-examples/actions/workflows/build-pre-release.yaml)\n[![definitions-test](https://img.shields.io/github/actions/workflow/status/fpgawars/apio-definitions/test.yaml?label=definitions-test)](https://github.com/fpgawars/apio-definitions/actions/workflows/test.yaml)\n[![definitions-build](https://img.shields.io/github/actions/workflow/status/fpgawars/apio-definitions/build-pre-release.yaml?label=definitions-build)](https://github.com/fpgawars/apio-definitions/actions/workflows/build-pre-release.yaml)\n[![oss-cad-suite-build](https://img.shields.io/github/actions/workflow/status/fpgawars/tools-oss-cad-suite/build-pre-release.yaml?label=oss-cad-suite-build)](https://github.com/fpgawars/tools-oss-cad-suite/actions/workflows/build-pre-release.yaml)\n[![verible-build](https://img.shields.io/github/actions/workflow/status/fpgawars/tools-verible/build-pre-release.yaml?label=verible-build)](https://github.com/fpgawars/tools-verible/actions/workflows/build-pre-release.yaml)\n[![graphviz-build](https://img.shields.io/github/actions/workflow/status/fpgawars/tools-graphviz/build-pre-release.yaml?label=graphviz-build)](https://github.com/fpgawars/tools-graphviz/actions/workflows/build-pre-release.yaml)\n[![drivers-build](https://img.shields.io/github/actions/workflow/status/fpgawars/tools-drivers/build-pre-release.yaml?label=drivers-build)](https://github.com/fpgawars/tools-drivers/actions/workflows/build-pre-release.yaml)\n[![workflows-test](https://img.shields.io/github/actions/workflow/status/fpgawars/apio-workflows/test.yaml?label=workflows-test)](https://github.com/fpgawars/apio-workflows/actions/workflows/test.yaml)\n[![apio-backup](https://img.shields.io/github/actions/workflow/status/fpgawars/apio-workflows/backup-apio-repos.yaml?label=apio-backup)](https://github.com/fpgawars/apio-workflows/actions/workflows/backup-apio-repos.yaml)\n\n---\n\n\n\u003e **NOTE:\u0026nbsp;\u0026nbsp;Apio IDE for Visual Studio Code.**\n\u003e Apio is also available as an extension for Visual Studio Code. To install it, visit the [Apio IDE page](https://marketplace.visualstudio.com/items?itemName=fpgawars.apio) in the Visual Studio Code Marketplace. \n\u003e The rest of this page describes the command line version of Apio.\n\n\nApio 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.\n\n\nSimulation example:\n\n![GTKWave screenshot](https://raw.githubusercontent.com/zapta/apio/main/media/sim-gtkwave.png)\n\n## Description\n\nApio 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.\n\nApio 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.\n\nApio 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.\n\n## Sample Apio CLI session\n\n1. `apio examples fetch alhambra-ii/getting-started` - fetch an example.\n2. `apio build` - build the project.\n3. `apio report` - report utilization and max clock speed.\n4. `apio sim` - simulate the design and show signals.\n5. `apio upload` - program the FPGA board.\n\n![apio-cli-animation](https://raw.githubusercontent.com/zapta/apio/main/media/apio-cli-animation.gif)\n\n## Apio CLI in the media\n\n[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\n\n[![Introduction to FPGA YouTube Series](https://raw.githubusercontent.com/ShawnHymel/introduction-to-fpga/main/images/Intro%20to%20FPGA%20Part%201_Thumbnail.png)](https://www.youtube.com/watch?v=lLg1AgA2Xoo\u0026list=PLEBQazB0HUyT1WmMONxRZn9NmQ_9CIKhb)\n\nAs the user **gh02t** said in this post on [Hacker-news](https://news.ycombinator.com/item?id=17912510):\n\n\u003e 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\u0026R, 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`\n\n## Resources\n\n- [Apio CLI Documentation](https://fpgawars.github.io/apio/docs/)\n- [Getting started with Apio](https://fpgawars.github.io/apio/docs/quick-start)\n- [Apio CLI github repository](https://github.com/fpgawars/apio)\n- [Apio CLI package on PyPi](https://pypi.org/project/apio/)\n- [Apio CLI development environment](https://fpgawars.github.io/apio/docs/development-environment/) (for Apio CLI developers).\n- [Apio CLI daily build](https://github.com/fpgawars/apio/releases)\n- [Apio CLI Test Coverage Report](https://fpgawars.github.io/apio/coverage/)\n\n## Credits\n\n- 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.\n- Thanks to all the Apio CLI [contributors](https://github.com/FPGAwars/apio/graphs/contributors) over the years.\n- 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).\n- [BQ](https://www.bq.com) sponsored this project from 02/2016 to 11/2016. Thanks.\n\n## License\n\nThe Apio project itself is licensed under the GNU General Public License version 3.0 (GPL-3.0).\nPre-built packages may include third-party tools and components, which are subject to their\nrespective license terms.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffpgawars%2Fapio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffpgawars%2Fapio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffpgawars%2Fapio/lists"}