Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/api/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,14 @@ Full working examples are available in the open-source GitHub repo:

Each example includes a complete server with API routes and a browser frontend for testing.

You can also scaffold any of these example architectures instantly using our CLI tool:

```bash
npx @bitbybit-dev/create-app my-cloud-project
```

Select the **cloud** app type when prompted, then choose your preferred backend template (Hono + SDK, Hono + REST, Node.js + SDK, Node.js + REST, or .NET + REST). The CLI generates a ready-to-run project with a React + Three.js frontend, your chosen backend, and all configuration in place — just add your API key and start developing.

## Next steps

- [**Studio introduction**](/api/studio/intro) — explore the visual dashboard
Expand Down
2 changes: 1 addition & 1 deletion docs/api/sdk/typescript/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const client = new BitbybitClient({

| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `apiKey` | `string` | *required* | Your API key. Get one at [bitbybit.dev/auth/pick-plan](https://bitbybit.dev/auth/pick-plan). |
| `apiKey` | `string` | *required* | Your API key. Get one at [bitbybit.dev/auth/pick-plan](https://bitbybit.dev/auth/pick-plan?api-keys=true). |
| `baseUrl` | `string` | `https://api.bitbybit.dev` | API base URL. |
| `validate` | `boolean` | `true` | Validate request bodies before sending. See [Validation](./validation). |

Expand Down
14 changes: 14 additions & 0 deletions docs/blog/2026-01-14-create-bitbybit-app-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,20 @@ PlayCanvas offers a fast and lightweight approach to WebGL development. It's des

No matter which engine you choose, the Bitbybit geometry kernels work with all of them. You can create complex CAD geometry with OCCT and render it beautifully in any of these engines.

## Cloud Projects: Server-Side CAD

The CLI isn't just for frontend apps anymore. You can now scaffold **cloud** projects that pair a backend server with a React + Three.js frontend, connecting to our [CAD Cloud API](/api/cloud-api) for server-side model generation, STEP-to-glTF conversion, and CAD pipelines.

Run the CLI and select the **cloud** app type when prompted. Then pick from five backend templates:

- **Hono + SDK** — TypeScript SDK on Cloudflare Workers
- **Hono + REST** — raw `fetch` on Cloudflare Workers
- **Node.js + SDK** — TypeScript SDK on Express 5
- **Node.js + REST** — raw `fetch` on Express 5
- **.NET + REST** — `HttpClient` on ASP.NET Core (.NET 10)

Your API key stays on the server, and the frontend proxies all requests through your backend. Add your key, run `npm install`, and you're building a full-stack CAD application.

## Why This Matters

We believe that the future of CAD and 3D design is on the web. Browser-based tools are accessible to everyone, require no installation, and can run on virtually any device. But building these tools has been harder than it should be.
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/2026-02-04-step-assembly-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ slug: step-assembly-support-v1-rc1
title: "STEP Assembly Support: Load, Parse, and Export Professional CAD Files"
authors: [ubarevicius]
tags: [occt, assembly, step, gltf, cad, freecad]
description: "Bitbybit v1.0.0-rc.2 introduces STEP assembly support - load complex CAD files, parse part hierarchies, extract components, preserve colors, and export to GLTF or STEP formats."
description: "Bitbybit v1.0.0 introduces STEP assembly support - load complex CAD files, parse part hierarchies, extract components, preserve colors, and export to GLTF or STEP formats."
image: https://ik.imagekit.io/bitbybit/app/assets/blog/step-assembly-support/step-assembly-support-occt-bitbybit.webp
---

Expand All @@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem';

If you've ever tried to load, edit or create a complex STEP assembly in a web browser, you know how tricky it can be. STEP is the standard format engineers use to share CAD models, but browsers don't understand it natively. You usually need desktop software or a server to convert it.

With **Bitbybit v1.0.0-rc.2**, that changes. You can now load STEP assemblies directly in the browser, explore their structure, extract individual parts, and export to web-friendly formats. Everything runs locally using Bitbybit OCCT WebAssembly.
With **Bitbybit v1.0.0**, that changes. You can now load STEP assemblies directly in the browser, explore their structure, extract individual parts, and export to web-friendly formats. Everything runs locally using Bitbybit OCCT WebAssembly.

<!-- truncate -->

Expand Down
27 changes: 26 additions & 1 deletion docs/learn/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ We believe that for a true 3D metaverse to flourish, and for 3D literacy to beco
**Our Mission:**
We strongly believe that educated users of 3D experiences will become the next wave of creators and innovators. The knowledge of 3D programming needs to spread, and that's why "Bit By Bit Developers" exists. Our mission is to build the fundamental blocks of code that empower you to easily create 3D worlds with your own rules and forces of nature.

We don't aim to reinvent the web but to leverage its best parts and standards. This includes providing **open-source NPM packages and runners** that allow developers to integrate our powerful geometry engine directly into their own websites and custom applications, truly embodying the web's spirit of interoperability and pushing 3D education and creativity forward.
We don't aim to reinvent the web but to leverage its best parts and standards. This includes providing **open-source NPM packages and runners** that allow developers to integrate our powerful geometry engine directly into their own websites and custom applications, truly embodying the web's spirit of interoperability and pushing 3D education and creativity forward. We also provide managed **CAD Cloud infrastructure** so teams can run geometry operations server-side without maintaining their own compute, and a **3D Bits app for Shopify** that brings interactive 3D product experiences to e-commerce.

## Our Platform Components

Expand All @@ -37,6 +37,8 @@ Our platform is designed to provide a comprehensive environment for 3D creation,
2. **Cloud Services for Collaboration and Sharing**
3. **Online School for Structured Learning**
4. **NPM Packages & Runners for Custom Integration**
5. **CAD Cloud API for Server-Side Geometry**
6. **3D Bits App for Shopify**

### 1. 3D Model Configurators & Parametric Editors

Expand Down Expand Up @@ -94,6 +96,29 @@ Beyond our hosted platform, we empower developers to take our core technology in

This extensibility ensures that Bitbybit can be a foundational layer for a wide array of web-based 3D solutions, from educational tools in **STEM classrooms** to bespoke configurators on e-commerce sites.

### 5. CAD Cloud API for Server-Side Geometry

Not every 3D workflow belongs in the browser. Our **CAD Cloud API** provides fully managed compute infrastructure for running CAD kernel operations server-side. Submit a job via HTTP, poll for completion, and download the result — from any backend, in any programming language.

* **Parametric Model Generation:** Generate 3D models on demand using our library of parametric templates.
* **File Conversion:** Convert STEP files to glTF and other formats at scale.
* **CAD Operations:** Run boolean operations, fillets, transforms, and full CAD pipelines without managing OCCT or WASM yourself.
* **Bitbybit Studio:** A browser-based dashboard at [**studio.bitbybit.dev**](https://studio.bitbybit.dev) for managing API keys, testing models, converting files, and monitoring tasks.
* **TypeScript SDK:** The [`@bitbybit-dev/cad-cloud-sdk`](https://www.npmjs.com/package/@bitbybit-dev/cad-cloud-sdk) package provides a convenient client for Node.js, Deno, Bun, and Cloudflare Workers.

Learn more in our [**CAD Cloud API documentation**](/api/cloud-api).

### 6. 3D Bits App for Shopify

For Shopify merchants, our [**3D Bits app**](https://apps.shopify.com/3d-bits-1) brings interactive 3D experiences directly to product pages without any coding.

* **3D Product Viewers:** Display GLTF models, Gaussian Splatting scans, and other 3D assets on your storefront.
* **Parametric Configurators:** Let customers customize products in real time using CAD-powered configurators you design in our editors.
* **Theme App Extensions:** Drop pre-built blocks — **BITBYBIT RUNNER**, **BITBYBIT VIEWER**, and **BITBYBIT PREVIEW** — into your Shopify theme. No code changes to your theme are required.
* **Variant Integration:** Connect 3D scene changes to Shopify product variants and custom option apps for a seamless shopping experience.

Get started with our [**3D Bits tutorials**](/learn/3d-bits/tutorials/videos-tutorials/set-up) or install the app from the [**Shopify App Store**](https://apps.shopify.com/3d-bits-1).

---

We are committed to building an open, accessible, and powerful platform for the next generation of 3D creators, educators, and developers. Join us in this journey!
19 changes: 17 additions & 2 deletions docs/learn/getting-started/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
sidebar_position: 1
title: Getting Started Overview
sidebar_label: Overview
description: Learn about the different ways to use our platform, including 3D Model Configurators, Rete, Blockly, and Monaco (TypeScript) editors.
tags: [getting-started, typescript, occt, jscad, manifold, rete, blockly]
description: Learn about the different ways to use our platform, including 3D Model Configurators, Rete, Blockly, and Monaco (TypeScript) editors, CAD Cloud API, and 3D Bits for Shopify.
tags: [getting-started, typescript, occt, jscad, manifold, rete, blockly, cad-cloud, shopify]
---

import Admonition from '@theme/Admonition';
Expand Down Expand Up @@ -96,6 +96,7 @@ npx @bitbybit-dev/create-app my-project --engine babylonjs
# or --engine threejs
# or --engine playcanvas
```
The CLI also supports scaffolding **CAD Cloud** backend projects. Run it without arguments and select the **cloud** app type to generate a full-stack project with your choice of backend (Hono, Node.js, or .NET) and a React + Three.js frontend. See the [CAD Cloud API docs](/api/cloud-api) for details.
</Admonition>

<Admonition type="info" title="What's Included (and Not Included)">
Expand All @@ -111,6 +112,20 @@ npx @bitbybit-dev/create-app my-project --engine babylonjs

For a comprehensive list of available NPM packages and more detailed guides, please visit our [**NPM Packages documentation page**](/learn/npm-packages/intro).

## CAD Cloud API

If your workflow requires server-side CAD operations — for example, generating models on demand from a backend, converting STEP files to glTF at scale, or running boolean and fillet operations without shipping WASM to the browser — our **CAD Cloud API** handles the heavy lifting on managed infrastructure.

Every request follows an asynchronous task model: submit a job, receive a task ID, poll for completion, and download the result in your preferred format (glTF, STEP, or decomposed mesh JSON). You can manage everything through the [**Bitbybit Studio**](https://studio.bitbybit.dev) dashboard or integrate programmatically using our [**TypeScript SDK**](https://www.npmjs.com/package/@bitbybit-dev/cad-cloud-sdk).

For full details, see our [**CAD Cloud API documentation**](/api/cloud-api).

## 3D Bits App for Shopify

Selling physical products online? Our [**3D Bits app for Shopify**](https://apps.shopify.com/3d-bits-1) lets you embed interactive 3D product viewers, parametric configurators, and Gaussian Splatting scans directly into your Shopify storefront. Design your 3D experience in any of our editors, then drop it onto a product page using theme app extension blocks — no theme code changes needed.

Learn how to set it up in our [**3D Bits tutorials**](/learn/3d-bits/tutorials/videos-tutorials/set-up).

## API Documentation

All our editors (Rete, Blockly, Monaco) are built upon the same core set of algorithms. This means that much of the underlying functionality overlaps between them. While each editor excels in its specific use cases, it's often possible to implement similar features across any of the editors.
Expand Down
7 changes: 7 additions & 0 deletions docs/learn/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,17 @@ To get started:
* We offer [**NPM packages**](/learn/npm-packages/intro) that you can incorporate into your own websites.
* *Note: These packages do not include our proprietary advanced algorithms or the models available in the 3D Models section.*
* Check out how to set up our algorithms with [**Three.JS**](/learn/npm-packages/threejs), [**Babylon.JS**](/learn/npm-packages/babylonjs) or [**PlayCanvas**](/learn/npm-packages/playcanvas). We include some complete powerful demos with explanations.
* Need server-side CAD? Our [**CAD Cloud API**](/api/cloud-api) lets you generate parametric models, convert STEP files to glTF, and run CAD kernel operations via HTTP from any backend. A [**TypeScript SDK**](https://www.npmjs.com/package/@bitbybit-dev/cad-cloud-sdk) is available.
* Also consider our course: [**Introduction To Programming 3D In TypeScript**](https://bitbybit.dev/school/courses/introduction-to-programming-3d-in-typescript).
* Or, if you're familiar with BabylonJS: [**Bitbybit For BabylonJS Developers**](https://bitbybit.dev/school/courses/bitbybit-for-babylonjs-developers).
These courses explore how our algorithms can create 3D CAD applications.

### Do you sell on Shopify?

Our [**3D Bits app for Shopify**](https://apps.shopify.com/3d-bits-1) lets you add interactive 3D product viewers, parametric configurators, and even Gaussian Splatting scans directly to your Shopify product pages — no coding required. Design your 3D experience in our editors, export it, and paste it into a product metafield. The app's theme extension handles the rest.

* Learn more in our [**3D Bits tutorials**](/learn/3d-bits/tutorials/videos-tutorials/set-up).

### Are you looking for ready-made 3D models?

Many of our standalone 3D model configurators require a subscription to our paid plans: Silver or Gold.
Expand Down
4 changes: 2 additions & 2 deletions docs/learn/npm-packages/babylonjs/start-with-babylon-js.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ npm run dev`}

This creates a complete project with Vite, TypeScript, and all three CAD kernels (OCCT, JSCAD, Manifold) pre-configured.

<Admonition type="tip" title="New to Bitbybit?">
Check out the [Getting Started with BabylonJS](/learn/getting-started/engines/babylonjs) page for an overview of all integration approaches including visual editors and runners.
<Admonition type="info" title="Need Server-Side CAD?">
The CLI can also scaffold **cloud** projects that pair a backend with a React + Three.js frontend for server-side CAD operations via our [CAD Cloud API](/api/cloud-api). Run it without `--engine` and select the **cloud** app type.
</Admonition>

---
Expand Down
45 changes: 38 additions & 7 deletions docs/learn/npm-packages/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,23 @@ When developing standalone applications in TypeScript or JavaScript, you often u

## Quick Start with CLI

The fastest way to get started is with our CLI tool. Scaffold a fully-configured 3D CAD project in seconds:
The fastest way to get started is with our CLI tool. Scaffold a fully-configured project in seconds:

```bash
npx @bitbybit-dev/create-app my-awesome-project
```

The CLI guides you through an interactive setup where you choose your preferred 3D engine (Three.js, Babylon.js, or PlayCanvas). You can also specify the engine directly:
The CLI guides you through an interactive setup where you first choose the **app type** — a browser-based **frontend** 3D app or a **cloud** project that pairs a backend with a frontend for server-side CAD via our [CAD Cloud API](/api/cloud-api).

### Frontend Projects

Choose your preferred 3D engine (Three.js, Babylon.js, or PlayCanvas). You can also specify it directly:

```bash
npx @bitbybit-dev/create-app my-project --engine babylonjs
```

### What You Get

Your scaffolded project includes:
Your scaffolded frontend project includes:

- **Vite** for fast development and optimized production builds
- **TypeScript** configured out of the box
Expand All @@ -38,6 +40,20 @@ Your scaffolded project includes:
- **Manifold** for fast mesh boolean operations
- **Starter code** demonstrating each kernel's capabilities

### Cloud (Backend + Frontend) Projects

When you select the **cloud** app type, the CLI scaffolds a full-stack project with a backend server that communicates with the Bitbybit CAD Cloud API and a React + Three.js frontend for visualizing results. Choose from five backend templates:

| Template | Framework | API Style |
|----------|-----------|----------|
| **Hono + SDK** | Hono (Cloudflare Workers) | TypeScript SDK |
| **Hono + REST** | Hono (Cloudflare Workers) | Raw REST |
| **Node.js + SDK** | Express 5 (Node.js) | TypeScript SDK |
| **Node.js + REST** | Express 5 (Node.js) | Raw REST |
| **.NET + REST** | ASP.NET Core (.NET 10) | Raw REST |

Your API key stays on the server — the frontend proxies requests through your backend, so credentials are never exposed to the browser. Learn more in the [CAD Cloud API documentation](/api/cloud-api).

### Development Workflow

```bash
Expand All @@ -46,7 +62,7 @@ npm install
npm run dev
```

Your browser opens with a live 3D preview at `http://localhost:5173`. Changes appear instantly with hot reload.
For frontend projects, your browser opens with a live 3D preview at `http://localhost:5173`. Changes appear instantly with hot reload. For cloud projects, follow the backend-specific setup instructions in the generated README to configure your API key and start both the backend and frontend.

---

Expand Down Expand Up @@ -148,4 +164,19 @@ Contains Manifold 3D algorithms. The Manifold geometry kernel was started by Emm
- [NPM Package](https://www.npmjs.com/package/@bitbybit-dev/base)
- [GitHub Source](https://github.com/bitbybit-dev/bitbybit/tree/master/packages/dev/base)

Contains foundational algorithms for the Bitbybit platform, used in all higher-level NPM packages. Includes utilities for vectors, math, text manipulation, and other basic operations.
Contains foundational algorithms for the Bitbybit platform, used in all higher-level NPM packages. Includes utilities for vectors, math, text manipulation, and other basic operations.

---

## CAD Cloud SDK

If you need server-side CAD operations without managing your own infrastructure, our **CAD Cloud API** provides managed compute for generating parametric 3D models, converting STEP files to glTF, and running CAD kernel operations — all via HTTP from any backend, in any programming language.

### @bitbybit-dev/cad-cloud-sdk

- [NPM Package](https://www.npmjs.com/package/@bitbybit-dev/cad-cloud-sdk)
- [GitHub Source](https://github.com/bitbybit-dev/bitbybit/tree/master/packages/dev/cad-cloud-sdk)

The official TypeScript SDK for the Bitbybit CAD Cloud API. Works in Node.js, Deno, Bun, and Cloudflare Workers. Submit CAD jobs, poll for completion, and download results in formats like glTF, STEP, and decomposed mesh JSON.

To learn more about the CAD Cloud API, Bitbybit Studio dashboard, and full example projects, visit our [**CAD Cloud API documentation**](/api/cloud-api).
4 changes: 2 additions & 2 deletions docs/learn/npm-packages/playcanvas/start-with-playcanvas.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ npm run dev`}

This creates a complete project with Vite, TypeScript, and all three CAD kernels (OCCT, JSCAD, Manifold) pre-configured.

<Admonition type="tip" title="New to Bitbybit?">
Check out the [Getting Started with PlayCanvas](/learn/getting-started/engines/playcanvas) page for an overview of all integration approaches including runners.
<Admonition type="info" title="Need Server-Side CAD?">
The CLI can also scaffold **cloud** projects that pair a backend with a React + Three.js frontend for server-side CAD operations via our [CAD Cloud API](/api/cloud-api). Run it without `--engine` and select the **cloud** app type.
</Admonition>

---
Expand Down
4 changes: 2 additions & 2 deletions docs/learn/npm-packages/threejs/start-with-three-js.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ npm run dev`}

This creates a complete project with Vite, TypeScript, and all three CAD kernels (OCCT, JSCAD, Manifold) pre-configured.

<Admonition type="tip" title="New to Bitbybit?">
Check out the [Getting Started with ThreeJS](/learn/getting-started/engines/threejs) page for an overview of all integration approaches including runners.
<Admonition type="info" title="Need Server-Side CAD?">
The CLI can also scaffold **cloud** projects that pair a backend with a React + Three.js frontend for server-side CAD operations via our [CAD Cloud API](/api/cloud-api). Run it without `--engine` and select the **cloud** app type.
</Admonition>

---
Expand Down
Loading
Loading