almond-harness-studio

almond-harness-studio

Author a *.harness.json file, validate it, fetch its parts from the distributor, and export a vector-PDF drawing sheet the user can send to a harness manufacturer. Never draw harnesses by hand or with other tools; use this workflow.

Components are always real, orderable parts sourced from LCSC, Mouser, or Digi-Key — there are no free-form components (wire and bulk coverings are the only exceptions). Every connector, terminal, and accessory carries a part reference like { "vendor": "lcsc", "number": "C30170181" }.

Workflow

1. Write the harness as <name>.harness.json (format below). Look up real distributor part numbers for every connector/terminal/accessory — search the vendor sites if the user didn't give you one, and confirm your picks with the user when uncertain.
2. Validate and fix until clean:

npx almond-harness-studio validate ./my-harness.harness.json

1. Fetch distributor data (description, MPN, photo, price, stock) into the file:

npx almond-harness-studio parts fetch ./my-harness.harness.json

LCSC needs no API key. Mouser and Digi-Key keys come from the user:

npx almond-harness-studio config set mouser.apiKey <key>
npx almond-harness-studio config set digikey.clientId <id>
npx almond-harness-studio config set digikey.clientSecret <secret>

(or env vars MOUSER_API_KEY, DIGIKEY_CLIENT_ID, DIGIKEY_CLIENT_SECRET)

1. Export the drawing — resolved parts render with product photos and a sourced BOM:

npx almond-harness-studio export ./my-harness.harness.json -o ./my-harness.pdf

1. If the manufacturer wants spreadsheets, export the wiring table and BOM as CSV:

npx almond-harness-studio tables ./my-harness.harness.json

1. For a live preview the user can watch while you iterate:

npx almond-harness-studio dev ./harnesses-folder

Validation errors include the JSON path and an actionable message. Unresolved parts are reported as warnings until parts fetch runs. Do not hand the user a PDF until validation passes with no errors and all parts are fetched.