Skip to content

akamai/edgeworkers-vscode

Repository files navigation

Akamai EdgeWorkers Toolkit for VSCode

Install

  1. Install the latest VS Code

  2. Install the Akamai EdgeWorkers Toolkit for VSCode from the Visual Studio Code Marketplace

Dependencies / Usage

  1. The EdgeWorkers panel will be automatically added to the left side of the VSCode window.

  2. The EdgeWorkers Toolkit for VSCode depends on the Akamai CLI, minimum version 1.3.0 with EdgeWorkers command minimum version 1.4.1. Many of our customers will already have this set up, but if not on first launch of the EdgeWorkers panel they will be prompted to install and set up OPEN API credentials in .edgerc as outlined in the developer docs. Usage from here assumes you have completed this step.

  3. Additional configuration is available in the VSCode preferences; most customers will not need to use this but if they use multiple .edgerc sections or a custom edgerc path they will, and Akamai internal users will likely need to fill in Account Key here:

Functionality Walkthrough

  1. List EdgeWorker details in the left side panel:

  1. See EdgeWorker versions and version file contents by clicking through the tree:

  1. Download an EdgeWorker by clicking the download button to the right of the version number. The download is automatically extracted for easy viewing of contents:

  1. Activating an EdgeWorker can be done by clicking the leftmost / “Activate EdgeWorker” icon in the EdgeWorkers pane toolbar; this will bring up the Activation UI:

  1. Registering a new EdgeWorker can by done by clicking on the R / “Register EdgeWorker” icon in the EdgeWorkers pane toolbar

  2. A new version for an existing EdgeWorker can by added via the + button next to an EdgeWorker:

  1. Or by right-clicking on an EdgeWorker tarball/bundle in the VS Code file explorer:

  1. As shown above the same tarball can also be uploaded to the EdgeWorkers Sandbox for testing.

  2. New EdgeWorker tarballs can be created + validated from source code by right-clicking on an EdgeWorker tarball.json in VS Code file explorer:

  1. Code profiling is available by bringing up the bottom panel or terminal window. More info on profiling code with the EdgeWorkers Toolkit for VSCode, check out Akamai Techdocs page on the EdgeWorkers Code Profiler.