@bitbybit-dev/core
v1.0.1
Published
Bit By Bit Developers Core CAD API to Program Geometry
Maintainers
Readme
@bitbybit-dev/core
Core assembly layer for Bitbybit CAD platform - combines all geometry kernels (OCCT, JSCAD, Manifold) into a unified API and provides additional cross-kernel features.
Overview
This package assembles the various Bitbybit kernel packages and provides additional features that combine all CAD kernels. It is the central integration point used by engine-specific packages like @bitbybit-dev/babylonjs, @bitbybit-dev/threejs, and @bitbybit-dev/playcanvas.
Note: If you used this package prior to v0.18.0, please switch to the engine-specific package for your renderer (e.g.
@bitbybit-dev/babylonjs).
Quick Start
The fastest way to scaffold a project using Bitbybit packages:
npx @bitbybit-dev/create-app my-project --engine babylonjs
cd my-project
npm install
npm run devThis creates a complete Vite + TypeScript project with all CAD kernels pre-configured. Learn more about the CLI.
Need Server-Side CAD?
The CLI first asks you to choose between a Frontend app or a CAD Cloud app. Select "cloud" to scaffold a full-stack project with a backend (Hono on Cloudflare Workers, Node.js Express, or ASP.NET Core) and a React + Three.js frontend. Your API key stays on the server and the frontend proxies requests through your backend:
npx @bitbybit-dev/create-app my-cloud-project --type cloudChoose from 5 backend templates: Hono + SDK, Hono + REST, Node.js + SDK, Node.js + REST, or .NET + REST. Each includes ready-to-run examples with model generation, batch operations, and CAD pipelines. Learn more.
Links
| Resource | URL | |----------|-----| | GitHub | https://github.com/bitbybit-dev/bitbybit/tree/master/packages/dev/core | | Monorepo | https://github.com/bitbybit-dev/bitbybit | | NPM | https://www.npmjs.com/package/@bitbybit-dev/core | | Documentation | https://learn.bitbybit.dev/learn/npm-packages/intro |
Example Applications
| App | Source Code | |-----|-------------| | Hex Shell | GitHub | | Cup Configurator | GitHub | | Hex House Concept | GitHub | | Terrace Furniture (BabylonJS) | Closed source |
Development
# Build package
tsc -p tsconfig.bitbybit.jsonBitbybit 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
- AI-Assisted Development - Context files for GitHub Copilot, Claude, and ChatGPT
- 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
Major Dependencies
BabylonJS, ThreeJS, PlayCanvas, OpenCascade, JSCAD, Manifold, Verbnurbs
License
MIT © Bit By Bit Developers
