Skip to content

waldiez/vscode

Repository files navigation

@waldiez/vscode

A waldiez extension for Visual Studio Code.

Waldiez Overview

Features

  • Visualize .waldiez files
  • Load existing .waldiez flows
  • Convert .waldiez flows to .py scripts or .ipynb notebooks
  • Handle uploaded files in .waldiez flows (for RAG)
  • Run .waldiez flows using a compatible python interpreter

Requirements

  • Visual Studio Code v1.95.0 or later
  • Python >= 3.10, < 3.13 (for converting and/or running .waldiez flows)
  • Vscode Python Extension

Installation

The extension is still a work in progress and is not yet available in the Visual Studio Code marketplace. You can either download the latest waldiez-vscode-x.y.z.vsix from the releases page or build and install the extension locally.

To build the extension locally, follow the instructions below.

  1. Make sure you have node.js and yarn installed:
    • Node.js: https://nodejs.org/en/download/
    • Yarn:
      • (if needed) npm install -g corepack
      • corepack enable to use yarn without installing it globally
      • yarn set version stable to use the stable version of yarn
  2. Clone the repository
  3. Run yarn install to install the dependencies
  4. Run yarn build to build the extension. It should generate waldiez-vscode-x.y.z.vsix in the root directory

Install the extension by running code --install-extension waldiez-vscode-x.y.z.vsix or:

  • Go to the Extensions view.
  • Click Views and More Actions (or the ... icon) and select Install from VSIX....

Install from VSIX

After uninstalling the extension, to cleanup everything you can remove the extension files (waldiez.* folder) from the extensions directory. The extensions directory is located at:

  • Windows: %USERPROFILE%.vscode\extensions
  • macOS: ~/.vscode/extensions
  • Linux: ~/.vscode/extensions

Reference: https://code.visualstudio.com/api/working-with-extensions/publishing-extension#packaging-extensions

Known Issues

  • Uncaught NetworkError: Failed to execute 'importScripts' on 'WorkerGlobalScope'. Could not create web worker(s). Falling back to loading web worker code in main thread, which might cause UI freezes. microsoft/vscode#233060. This is a known issue in VSCode and might cause performance degradation.

License

This project is licensed under the MIT License - see the LICENSE file for details.