Boardreadyops

by oaslananka

1 stars
225 downloads
Not rated
GitHub Website

About

End-to-end hardware release pipeline for KiCad: generate, validate, sign, and package manufacturer-ready releases as a CLI and GitHub Action.

Details

Author
oaslananka
GitHub stars
1
Downloads
225

- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: oaslananka/boardreadyops@005afb83bd04f50a8da33bbffc441818910951f6 # v1.7.2
- uses: oaslananka/boardreadyops/apps/container@005afb83bd04f50a8da33bbffc441818910951f6 # v1.7.2
- name: production
- KiCad DRC and ERC report normalization

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Boardreadyops
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

The README includes setup instructions such as `npx boardreadyops --help also works when npm can resolve the package.`.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "boardreadyops": {
            "boardreadyops": {
                "command": "docker",
                "args": [
                    "run",
                    "--rm",
                    "ghcr.io/oaslananka/boardreadyops-full:v1",
                    "--help"
                ]
            }
        }
    }
}

McpServers

{
    "boardreadyops": {
        "command": "docker",
        "args": [
            "run",
            "--rm",
            "ghcr.io/oaslananka/boardreadyops-full:v1",
            "--help"
        ]
    }
}

BoardReadyOps

End-to-end hardware release pipeline for KiCad projects.

Verified, signed, manufacturer-ready release packages for KiCad projects.
Generate artifacts, validate release readiness, package evidence, and produce a clear release decision.

CI
Security
OpenSSF Scorecard
OpenSSF Best Practices

npm
npm downloads
GitHub Marketplace
License

Repository Maturity ·
OpenSSF Evidence ·
Governance ·
Roadmap ·
Support

Buy me a coffee

</div>

BoardReadyOps turns a KiCad project into a verified, signed, manufacturer-ready release package. It generates manufacturing artifacts, validates release readiness, packages evidence, and produces a clear release decision — running locally as a CLI and in CI as a GitHub Action, with JSON, SARIF, Markdown, HTML, JUnit, and workflow annotation output.

Generate → Validate → Decide → Package → Attest → Review → Handoff

Installation

npm i -g boardreadyops

The current public npm package is boardreadyops@1.7.2. It is verified on
Node.js 22.14+ and 24, includes the current CLI bundle, schemas, docs, Action
metadata, and matches the public v1.7.2 tag archive.
Binary release assets should be verified against v1.7.2, which publishes the
current Linux, macOS, and Windows binary matrix, SHA256SUMS, and SBOM release
assets. See release channel verification
for the tested artifact list and remaining channel follow-ups.

Runtime Support

BoardReadyOps supports Node.js 22.14+ and 24. Node.js 24 is the recommended Active
LTS runtime; Node.js 22.14+ remains supported for Maintenance LTS users. Node.js 26
Current is tracked but not supported in engines.node or CI until it reaches
LTS and dependency validation is added.

KiCad CLI compatibility is CI-tested on KiCad 10.0, with 10.0.4 as the latest
verified patch. KiCad 9.0 remains the minimum supported line but is upstream EOL
and no longer CI-tested. The machine-readable policy and generated support table
live in docs/support-matrix.md.

Install Via Script

Linux and macOS release binaries are installed with the checksum-verifying shell
installer when the selected GitHub Release includes the matching binary asset
and SHA256SUMS:

curl -fsSL https://raw.githubusercontent.com/oaslananka/boardreadyops/main/install.sh | sh

Windows x64 release binaries use the same release asset and checksum flow:

irm https://raw.githubusercontent.com/oaslananka/boardreadyops/main/install.ps1 | iex

The installers download the release asset plus SHA256SUMS before placing
boardreadyops on the local command path. Binary asset availability depends on
the release; check the latest release
for the current asset matrix. A Homebrew
formula template for the same binary assets lives at Formula/boardreadyops.rb;
it is populated with published macOS and Linux checksums from SHA256SUMS.
The installers have been verified against the latest release which includes
the full binary matrix, SHA256SUMS, and SBOM. Tap publication remains a
maintainer follow-up.

Positioning

BoardReadyOps provides two usage modes:

End-to-end pipeline — use boardreadyops generate to produce Gerbers, drill files, BOMs, CPL/position files, and PDFs via kicad-cli, then boardreadyops release prepare to validate, package evidence, and emit a signed release decision.

Validation-only gate — use KiBot or another generator to produce fabrication outputs, then use BoardReadyOps to validate those outputs exist, match the KiCad project, satisfy vendor/profile expectations, and can support a repeatable release decision.

See Release readiness and KiBot integration for the pipeline split approach, and the roadmap for v2 features.

Quick Start

```bash

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.