README.md

circuit-json-to-gerber

Convert a Circuit JSON to Gerber/Excellon files.

Installation

# Global installation for CLI usage
npm install -g circuit-json-to-gerber

CLI Usage

Convert a circuit JSON file to Gerber/Excellon files:

# Basic usage - outputs to input.gerbers.zip
circuit-to-gerber input.circuit.json

# Specify custom output file
circuit-to-gerber input.circuit.json -o output.zip

The output ZIP file will contain:

• Gerber files (*.gbr) for each layer
• Plated drill file (plated.drl)
• Unplated drill file (unplated.drl)

Library Usage

import {
  convertSoupToGerberCommands,
  stringifyGerberCommandLayers,
} from "circuit-json-to-gerber"
import {
  convertSoupToExcellonDrillCommands,
  stringifyExcellonDrill,
} from "circuit-json-to-gerber"

// Convert Circuit JSON to Gerber commands
const gerberCommands = convertSoupToGerberCommands(circuitJson)

// Convert to Gerber file content
const gerberOutput = stringifyGerberCommandLayers(gerberCommands)

// Generate drill files
const platedDrillCommands = convertSoupToExcellonDrillCommands({
  circuitJson,
  is_plated: true,
})
const unplatedDrillCommands = convertSoupToExcellonDrillCommands({
  circuitJson,
  is_plated: false,
})

const platedDrillOutput = stringifyExcellonDrill(platedDrillCommands)
const unplatedDrillOutput = stringifyExcellonDrill(unplatedDrillCommands)

References

• Gerber Format Specification (2022)
• Excellon Drill Format Specification