lipwig/cadquery-vscode
Archived
1
0
Fork 0
Code Issues Pull requests Activity
Build parametric 2D/3D CAD models in VSCode with the CadQuery library.
This repository has been archived on 2025-12-20. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
85 commits 1 branch 0 tags 373 KiB
  • JavaScript 100%
Find a file
Roipoussiere 59f8028738 add note about temporary LivePreview solution
2022-09-05 23:03:12 +02:00
.vscode bundle extension before testing it 2022-04-04 12:34:56 +02:00
examples update example 2022-09-05 22:54:25 +02:00
images remove now unnecessary files 2022-09-05 22:53:08 +02:00
.eslintrc.json initial commit: extension poc 2022-03-28 23:13:47 +02:00
.gitignore remove now unnecessary files 2022-09-05 22:53:08 +02:00
.yarnrc initial commit: extension poc 2022-03-28 23:13:47 +02:00
extension.js attempt to be compatible with new CadQuery Server 2022-09-05 22:48:36 +02:00
LICENSE initial commit: extension poc 2022-03-28 23:13:47 +02:00
package.json update package 2022-09-05 22:54:05 +02:00
README.md add note about temporary LivePreview solution 2022-09-05 23:03:12 +02:00
yarn.lock update package 2022-09-05 22:54:05 +02:00

README.md

VSCode CadQuery extension

Important note:

This extension is no longer compatible with the new version of CadQuery Server. Until this is resolved, please use the LivePreview extension instead:

  1. install LivePreview;
  2. ctrl+shift+P -> Simple Browser: Show
  3. update the url according to your running CadQuery server instance (ie. 127.0.0.1:5000).

VSCode extension that integrates CadQuery Server in VSCode.

CadQuery Server is a web server used to render 3d models from CadQuery code loaded dynamically.

Installation

Install the IDE

The extension works both on VSCodium or VSCode.

Install the extension

In VSCode, search for cadquery in Extensions tab in the sidebar.

The extension is available in:

Alternatively, you can manually install the extension in VSCode by downloading the vsix file from one on both registries.

Install CadQuery Server

Read installation instructions.

Usage

1. Run the CadQuery server

You can configure the server url in the VSCode extension settings (which is http://127.0.0.1:5000 by default).

source venv/bin/activate # required if you used a virtual environment
cq-server

Read usage instructions for advanced use.

2. Activate the extension

Hit f7 to enable the viewer. Alternatively you can use the VSCode command palette (Ctrl+Shift+P) and search for Open CadQuery viewer.

The preview should be updated each time your CadQuery Python script is saved.

3. Tips and tricks

You should use a language server to activate code completion, such as Pylance. Note that in order to make it work on VSCodium, you must set the nameLong value to Visual Studio Code in your product.json (located at /usr/share/codium/resources/app/product.json on Linux).

You can make the UI lighter by enabling VSCode Zen mode by hitting Ctrl+K then Z.

About