{"id":13626917,"url":"https://github.com/njourdane/cadquery-vscode","last_synced_at":"2025-04-26T00:33:32.837Z","repository":{"id":42776630,"uuid":"476017298","full_name":"njourdane/cadquery-vscode","owner":"njourdane","description":"Build parametric 2D/3D CAD models in VSCode with the CadQuery library.","archived":false,"fork":false,"pushed_at":"2022-09-05T21:04:27.000Z","size":432,"stargazers_count":21,"open_issues_count":5,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-04T05:41:58.069Z","etag":null,"topics":["3d","cad","cadquery","modeling","parametric","python","vscode-extension"],"latest_commit_sha":null,"homepage":"https://open-vsx.org/extension/roipoussiere/cadquery","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/njourdane.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-30T19:09:10.000Z","updated_at":"2025-02-02T03:49:46.000Z","dependencies_parsed_at":"2023-01-17T20:41:35.660Z","dependency_job_id":null,"html_url":"https://github.com/njourdane/cadquery-vscode","commit_stats":null,"previous_names":["njourdane/cadquery-vscode","roipoussiere/cadquery-vscode"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/njourdane%2Fcadquery-vscode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/njourdane%2Fcadquery-vscode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/njourdane%2Fcadquery-vscode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/njourdane%2Fcadquery-vscode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/njourdane","download_url":"https://codeload.github.com/njourdane/cadquery-vscode/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250917283,"owners_count":21507561,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d","cad","cadquery","modeling","parametric","python","vscode-extension"],"created_at":"2024-08-01T22:00:25.331Z","updated_at":"2025-04-26T00:33:32.552Z","avatar_url":"https://github.com/njourdane.png","language":"JavaScript","funding_links":[],"categories":["Editors and IDEs"],"sub_categories":[],"readme":"# VSCode CadQuery extension\n\n---\n\n**Important note:**\n\nThis extension is no longer compatible with the new version of CadQuery Server. Until this is resolved, please use the [LivePreview extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.live-server) instead:\n\n1. install LivePreview;\n2. `ctrl+shift+P` -\u003e Simple Browser: Show\n3. update the url according to your running CadQuery server instance (ie. `127.0.0.1:5000`).\n\n---\n\nVSCode extension that integrates [CadQuery Server](https://github.com/roipoussiere/cadquery-server) in VSCode.\n\nCadQuery Server is a web server used to render 3d models from CadQuery code loaded dynamically.\n\n![](images/screenshot.png)\n\n## Installation\n\n### Install the IDE\n\nThe extension works both on [VSCodium](https://vscodium.com/) or [VSCode](https://code.visualstudio.com/).\n\n### Install the extension\n\nIn VSCode, search for *cadquery* in Extensions tab in the sidebar.\n\nThe extension is available in:\n- [the Open VSX Registry](https://open-vsx.org/extension/roipoussiere/cadquery);\n- [the VisualStudio marketplace](https://marketplace.visualstudio.com/items?itemName=roipoussiere.cadquery).\n\nAlternatively, you can manually install the extension in VSCode by downloading the vsix file from one on both registries.\n\n### Install CadQuery Server\n\nRead [installation instructions](https://github.com/roipoussiere/cadquery-server#installation).\n\n## Usage\n\n### 1. Run the CadQuery server\n\nYou can configure the server url in the VSCode extension settings (which is `http://127.0.0.1:5000` by default).\n\n    source venv/bin/activate # required if you used a virtual environment\n    cq-server\n\nRead [usage instructions](https://github.com/roipoussiere/cadquery-server#usage) for advanced use.\n\n### 2. Activate the extension\n\nHit `f7` to enable the viewer. Alternatively you can use the VSCode command palette (`Ctrl+Shift+P`) and search for `Open CadQuery viewer`.\n\nThe preview should be updated each time your CadQuery Python script is saved.\n\n### 3. Tips and tricks\n\nYou 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).\n\nYou can make the UI lighter by enabling VSCode Zen mode by hitting `Ctrl+K` then `Z`.\n\n## About\n\n- contact:\n    - ping user `@roipoussiere` on channel `other-gui` in the CadQuery Discord;\n    - [Mastodon](https://mastodon.tetaneutral.net/@roipoussiere);\n- license: [MIT](./LICENSE);\n- source: [Framagit](https://framagit.org/roipoussiere/cadquery-vscode) (Gitlab instance) / [Github](https://github.com/roipoussiere/cadquery-vscode) (mirror);\n- issue tracker: [Framagit](https://framagit.org/roipoussiere/cadquery-vscode/-/issues) / [Github](https://github.com/roipoussiere/cadquery-vscode/issues)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnjourdane%2Fcadquery-vscode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnjourdane%2Fcadquery-vscode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnjourdane%2Fcadquery-vscode/lists"}