BushSCAD for Visual Studio Code
Write parametric CAD models in .bscd files, inspect the 3D result beside
your source, and export solids and drawings. BushSCAD provides native language
completion, hover, navigation, diagnostics, symbols, and color editing.
For additional information and language documentation, visit the
BushSCAD website.
Install and first model
In VS Code, open the Extensions view, search for BushSCAD by ByAidan,
and select Install. You can also install it from the
Visual Studio Marketplace
or run code --install-extension ByAidan.bushscad in a terminal. Reload VS Code
if prompted.
- Open a local folder you trust and save
first-model.bscd inside it.
- Paste this model:
base_unit = mm;
part block {
sketch profile = rect(20, 15);
obj body = extrude(profile, 10);
}
- Run BushSCAD: Compile Model from the Command Palette.
- Run BushSCAD: Open Model Preview for an editor-area preview, or open the
BushSCAD Activity Bar and its Model view. Your source stays a normal editor.
- Use the mouse to orbit/zoom and BushSCAD: Reset Camera to recover the view.
Opening a saved BushSCAD file in a trusted workspace warms one compiler worker
in the background so the first compile can reuse it.
- Model shows parts, source links, joints, drawings, and the basic timeline.
Select geometry to navigate to source; source selections highlight the model.
- Sketches is a read-only viewer available in the sidebar or through
BushSCAD: Open Sketch Preview. Interactive sketch editing, timeline
reordering, suppression, and write rollback are not part of this release.
Sketch previews include workspace imports and unsaved dependency edits.
- The model's three-dot menu contains Live compilation and STEP export. The
sketch menu offers Expand sketch view and Focus 3D model view.
- Build Operations shows worker/part timings and an accessible tree/table.
BushSCAD: Show Output opens the corresponding diagnostic log.
- The model's gear button opens renderer settings. BushSCAD: Open Settings
exposes engine, worker count, guides, materials, and highlighting preferences.
Views follow the active VS Code theme, including high contrast.
- BushSCAD: Toggle Live Compilation enables rebuilds after edits.
BushSCAD: Stop Compilation cancels work. A failed build retains the last
good model, marked stale until the next successful build.
- BushSCAD: Export STEP, Export STL, and Export Drawings compile the
active source and ask where to save the results.
- BushSCAD: Open Integrated Terminal opens VS Code's native terminal.
Supported environment
BushSCAD supports local Windows, macOS, and Linux workspaces with VS Code 1.135
or newer. WSL, Dev Containers, Remote SSH, and browser/virtual workspaces are
not currently supported. The compiler runtime is included; a separate BushSCAD
CLI installation is unnecessary. Compilation and exports require Workspace
Trust.
Extension development
The extension release version 1.0.4 is independent from the BushSCAD
language packages, which use version 0.3.0. Normal extension builds install
the public npm packages and bundle the matching compiler, language server, and
runtime into the VSIX. The language repository is not needed to run the
extension.
For local development with sibling language/ and vscode/ checkouts, install
the language workspace and run npm run link:language here before building.
This links the current public packages without changing the registry semver
ranges in this manifest. Maintainers can consult the private repository setup
guide for independent installs and release steps.
Troubleshooting and data
Open a saved BushSCAD file before compiling/exporting. Check Problems for
source errors and BushSCAD: Show Output for process or runtime failures.
After a failed compile, correct the source and compile again. For a blank or
misplaced view, reset the camera and check visibility settings.
The extension adds no telemetry or account requirement. Compilation and
language analysis run locally. Read the privacy statement
and private vulnerability reporting instructions.
The VSIX also includes its Apache 2.0 license, third-party notices, and the
exact OCCT source correspondence for redistributed WebAssembly.
Report reproducible bugs at the issue tracker.
Review paths and source content before sharing logs.
Detailed language help
Hover a command, reference, unit suffix, or modifier for its purpose, syntax, arguments, examples, and current limitations. Completion details show the same Markdown reference. User-defined symbols retain their declaration and value information.
License and your models
BushSCAD itself is licensed under Apache 2.0, as TypeScript is.
Your original BushSCAD files and exported models remain yours: you can keep
these private, share or sell them, and choose their license. Using BushSCAD
alone does not require publishing your designs or paying royalties to BushSCAD.
Imported assets and third-party software retain their own terms.