Install Sprkl
Last updated
Last updated
Watch how to install Sprkl in VSCode video here!
Node v16.10 and up (Java, C#, and Python are partially supported via our Kubernetes Setup).
Install the Sprkl VSCode Extension directly from VSCode.
Once installed, click on the Sprkl icon on the left panel.
Register and follow the activation instructions.
The Sprkl Client contains NodeJS libraries installed under $HOME/.sprkl/lib, and the Sprkl CLI installed under $HOME/.sprkl/bin.
Use the id provided in the vscode window as $ID.
To make sprkl binaries executable, we need to add the required binaries to a directory accessible by your PATH.
Create symlinks to a directory known by PATH, in Unix systems (both macOS and Linux), usually /usr/local/bin is a popular choice.
It might require privileges. If so, try to run with sudo:
Add the sprkl binaries directory to the PATH environment in your shell config. Usually $HOME/.bashrc for bash, and $HOME/.zshrc for zsh, etc.
After updating the PATH variable, reload your shell.
Activate and configure the install Sprkl CLI to work with your registered user. Use the id and the token provided in the VSCode or Web activation page as $ID and $TOKEN
All set. You're done. The dashboard should be empty as Sprkl analyzes code changes. After you make a code change and run Sprkl, the dashboard will be filled with info.
Following that, you can choose between bare metal, Docker, or running Sprkl with Kubernetes, if you're working with Kubernetes on your development environments.
Or, start with a sample project.
Navigate to instrument your code to get started.
