Skip to main content

Installation and Setup

Node.js

You must have the latest Node.js version installed on your machine to use the extension. To check if you have it installed, open a terminal and run this command:

node -v

You must have version 22.14.0 or higher.

If you don't have node installed, or have a lower version, go to the official nodejs page and download the latest installer for your platform (for Windows, the .msi file). Run the installer file, choosing default options when prompted. Once installed, return and call the command again and you should see the new version number. You should not have to restart VS Code after install.

Downloading the extension

The VS Code extension is not yet available via the public extensions marketplace. Please contact support@connectmyapps.com to receive a download link for the extension file.

Installing the extension

To install the extension in VS Code, run VS Code and go to the Extensions menu. In the top-right of the Extensions window click the elipsis button, "...", and choose "Install from VSIX". Navigate to the downloaded VSIX file and select it to install.

Canvas API Keys

A Canvas API key pair is required to authenticate the extension.

  • Log into Canvas.
  • Go to Profile under your account icon on the top right.
  • Go to API & Security Settings then API Keys.
  • Click Create Secret Key to create a key-pair. Be sure to copy the SecretKey and ConsumerKey as they will not be shown again.
info

Optional, but recommended: set an IP restriction on your API Keys for additional security when you have a fixed IP address, e.g. VPN.