Altium Cruncher

Command-line tools for working with Altium projects, schematics, boards and libraries on Windows, macOS and Linux. Export SVGs, generate BOM and pick-and-place files, extract library assets, and inspect or modify designs.

uv installs the application and manages its Python runtime and dependencies.

On Windows, open PowerShell and run:

powershell -ExecutionPolicy Bypass -c "irm https://astral.sh/uv/install.ps1 | iex"

On macOS or Linux:

curl -LsSf https://astral.sh/uv/install.sh | sh

Restart your terminal after installing uv.

To install the published package:

uv tool install altium-cruncher
uv tool update-shell

To install directly from GitHub, with Git installed:

uv tool install --force "git+https://github.com/wavenumber-eng/altium_cruncher.git@main"
uv tool update-shell

For a specific branch, tag or commit, replace main in the URL with that reference. Both installation methods provide the same command names: altium-cruncher and its shorter alias, acr.

Open a new terminal if the command is not found, then verify the installation:

acr version
acr --help

For an installation from PyPI:

uv tool upgrade altium-cruncher

For an installation from a GitHub branch, rerun the install command with --reinstall-package to refresh the source:

uv tool install --force --reinstall-package altium-cruncher "git+https://github.com/wavenumber-eng/altium_cruncher.git@main"

Use the same branch reference you selected when installing.

Get help for any command:

acr pcb-svg --help
acr bom --help

For example, export a board SVG or a project BOM:

acr pcb-svg board.PcbDoc
acr bom project.PrjPcb

See the command guide for the complete command list and links to individual usage instructions. Some commands, such as launching Altium Designer and running OutJobs, require Altium Designer on Windows.

uv tool uninstall altium-cruncher

• Command reference
• Examples
• Development and testing
• Contributing
• Architecture
• Release notes

Altium Cruncher is licensed under AGPL-3.0-or-later.