@bitbybit-dev/base
Base algorithms for Bitbybit CAD platform - math, vectors, matrices, lists, text utilities, and shared types used across all higher-level packages.
Overview
This package provides the foundational layer for all Bitbybit CAD packages. It includes helper functions for math, text, lists, vectors, and matrix operations, along with base types used throughout the platform. This layer is kept lightweight with zero third-party dependencies.
Works in both Node.js and browser environments.
Used By
This package is a dependency of all higher-level Bitbybit packages:
- @bitbybit-dev/occt - OpenCascade CAD kernel
- @bitbybit-dev/occt-worker - OCCT via WebWorker
- @bitbybit-dev/manifold - Manifold mesh booleans
- @bitbybit-dev/manifold-worker - Manifold via WebWorker
- @bitbybit-dev/jscad - JSCAD solid modeling
- @bitbybit-dev/jscad-worker - JSCAD via WebWorker
- @bitbybit-dev/core - Core assembly layer
- @bitbybit-dev/babylonjs - BabylonJS integration
- @bitbybit-dev/threejs - Three.js integration
- @bitbybit-dev/playcanvas - PlayCanvas integration
Quick Start
The fastest way to start a project using Bitbybit packages:
npx @bitbybit-dev/create-app my-project
This scaffolds a complete Vite + TypeScript project with all CAD kernels pre-configured. Learn more about the CLI.
Use It With an AI Agent
An agent that does not know an API invents plausible names for it, and Bitbybit has more functions across its three CAD kernels than any model holds in memory. The free Bitbybit CAD MCP server removes the guesswork: your agent looks up the exact signature, parameter defaults, return type and examples for the version of @bitbybit-dev/base your project has installed, and writes code that compiles the first time.
claude mcp add --transport http bitbybit https://mcp.bitbybit.dev/mcp
Cursor, VS Code, claude.ai, ChatGPT and the Claude API connect to the same endpoint; npx -y @bitbybit-dev/mcp runs the same server locally, pinned to your installed version. Every configuration is here.
With a CAD Cloud key, the Bitbybit CAD Cloud MCP goes further and lets the agent run the geometry for you - measure a STEP file, run a pipeline, convert to glTF - and hand back the results as files. For assistants that cannot speak MCP, the whole API is also published as context files. The AI section of the documentation explains all of it.
Links
| Resource | URL |
|---|---|
| GitHub | https://github.com/bitbybit-dev/bitbybit/tree/master/packages/dev/base |
| Monorepo | https://github.com/bitbybit-dev/bitbybit |
| NPM | https://www.npmjs.com/package/@bitbybit-dev/base |
| Documentation | https://learn.bitbybit.dev/learn/npm-packages/intro |
| API Reference | https://docs.bitbybit.dev/modules/Bit |
| Unit Test Coverage | https://github.com/bitbybit-dev/bitbybit/actions/workflows/verify.yml |
API reference
Every class, method and input type in this package is documented in the generated TypeScript API reference:
Example Applications
| App | Source Code |
|---|---|
| Hex Shell | GitHub |
| Cup Configurator | GitHub |
| Terrace Furniture (BabylonJS) | Closed source |
Development
# Build package
npm run build-p
# Run unit tests with coverage
npm run test:coverage
# Re-run them as you edit
npm run test:watch
Bitbybit Platform
Beyond NPM packages, Bitbybit offers:
- Visual Programming Editors - Rete & Blockly drag-and-drop 3D modeling, plus a Monaco TypeScript editor
- CAD Cloud API - Build full pipelines that compose all Bitbybit algorithms, where each step can reference outputs of previous steps. Supports parametric model generation, STEP-to-glTF conversion, and complex CAD workflows via HTTP
- Bitbybit Studio - A growing visual dashboard where API Key users can generate models, convert files, build pipelines with a GUI, inspect tasks, and preview 3D results
- 3D Bits for Shopify - Interactive 3D product configurators for e-commerce
- Script Runners - Execute visual scripts directly on your website
- Built for AI Coding Agents - The free Bitbybit CAD MCP gives Claude Code, Cursor, VS Code, claude.ai and ChatGPT the exact API of the version you use; with a key, the CAD Cloud MCP runs the geometry too
- Business & Enterprise - We help businesses and enterprises develop custom applications and spin up optimized CAD tenant workflows on our managed servers
Support the Project
This package is part of the open-source Bitbybit ecosystem. Your subscription helps fund continued development.
⭐ Subscribe - Silver or Gold plan | Get API Key for CAD Cloud
Community
License
MIT © Bit By Bit Developers