Official open-source SDKs, UI primitives, and examples for building applications with the Toolpath API.
Toolpath analyzes a CAD part so you can understand whether it fits your shop, how it can be machined, and what it may cost.
| I want to… | Use | Documentation |
|---|---|---|
| Call Toolpath from JavaScript | @toolpath/api |
TypeScript SDK |
| Call Toolpath from Python | toolpath |
Python SDK |
| Show a part in a React app | @toolpath/viewer |
Viewer |
| Build Toolpath-styled UI | @toolpath/ui |
UI kit |
| Collect vendor tool data | @toolpath/tool-scraper |
Tool scraper |
| Draw a tool and its holder | @toolpath/tool-drawing |
Tool drawing |
| Share the cutting-tool domain | @toolpath/tool-support |
Tool support |
| Share application logic | @toolpath/app-support |
App support |
| See usage examples | TypeScript, Python, or React | Examples |
| Start a customer application | Part Viewer template | toolpath-template |
| Call the API without an SDK | HTTP, cURL, or another language | API documentation |
The SDKs are generated from the same OpenAPI document, so their request and response types match the public API contract retained in this repository. They also provide a focused helper for directly uploading to the presigned URL returned by the create-part operation.
To analyze a part, you need:
- A Toolpath account and API key. Create a key in your Toolpath account.
- A STEP CAD file to upload.
- One supported programming environment:
- TypeScript/JavaScript: Node.js 24
- Python: Python 3.11 or newer
The TypeScript and Python examples create a part and upload its STEP file; your application controls analysis and report retrieval through the generated API bindings:
The React example renders a finished part with @toolpath/viewer instead of uploading one:
| Tool | What it does | Required for |
|---|---|---|
| Git | Downloads the repository and tracks source changes | All source workflows |
| Node.js 24.18+ | Runs the JavaScript tools; its installer also provides npm |
All source workflows |
| Corepack | Activates the exact pnpm version declared by this repository |
All source workflows |
| pnpm | Installs and runs this repository's JavaScript dependencies | All source workflows |
| Docker | Runs the pinned TypeScript OpenAPI generator image | SDK generation and pnpm check |
| Python 3.11+ | Runs the Python SDK and example | Python only |
| uv | Creates the Python environment and installs its dependencies | Python only |
These are development tools for this repository, and so is the Node.js 24.18+ floor above. A package installed from npm needs neither Corepack nor pnpm, and runs on Node.js 20 or newer.
Verify that Git and Node.js are available:
git --version
node --versionThe Node.js version must be v24.18.0 or newer within the v24 release line.
Open PowerShell, Command Prompt, Terminal, or your editor's terminal, then run:
git clone https://github.com/toolpath/ui-packages.git
cd ui-packages
corepack enable pnpm
pnpm install --frozen-lockfileReplace the sample key and file path with your own values.
Windows PowerShell:
$env:TOOLPATH_API_KEY = "your-api-key"
pnpm --filter @toolpath/example-typescript analyze -- "C:\path\to\part.step"Windows Command Prompt:
set TOOLPATH_API_KEY=your-api-key
pnpm --filter @toolpath/example-typescript analyze -- "C:\path\to\part.step"macOS or Linux:
TOOLPATH_API_KEY="your-api-key" pnpm --filter @toolpath/example-typescript analyze -- "/path/to/part.step"The command prints the complete analysis report after the report is ready.
Install uv using its platform-specific instructions,
then set TOOLPATH_API_KEY as shown above.
Windows:
uv run --project examples/python python examples/python/src/analyze_part.py "C:\path\to\part.step"macOS or Linux:
uv run --project examples/python python examples/python/src/analyze_part.py "/path/to/part.step"Agent and contributor instructions live in AGENTS.md; it is the fuller guide, and this section is the short version.
pnpm check is the gate. It runs openapi:verify, generate:check, lint, build,
check-types, and test, in that order. While implementing, run the narrowest thing instead —
pnpm --filter @toolpath/viewer test for one package — and save the full gate for the end.
Docker must be running for pnpm check. Its second step regenerates both SDKs in a pinned
openapi-generator container and compares the result against what is checked in, so a stopped
Docker daemon fails the gate before it ever reaches lint.
A consumer-visible change to a public package needs a Changeset in the same pull request. CI
enforces this and will fail the pull request without one. Add it with pnpm changeset, naming
every package the change affects, and see AGENTS.md for which paths belong to which package and
which bump to use. Never edit a package version or changelog by hand: the release workflow
generates both.
New packages need a one-time bootstrap publish before npm trusted publishing can take over. See Bootstrapping npm packages.
This project is licensed under the MIT License.