Install Sprkl
VSCode
Web
Once installed, click on the Sprkl icon on the left panel.
Register and follow the activation instructions.

Once activated, the Grafana button will be enabled, and you can navigate to the Sprkl dashboard in Grafana.

.png?alt=media&token=9831a71e-01b3-4539-9753-3ac7dbff8ac1)
The Sprkl Client contains NodeJS libraries installed under
$HOME/.sprkl/lib
, and the Sprkl CLI installed under $HOME/.sprkl/bin
.npx @sprkl/scripts install --id=$ID
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.ln -sf $HOME/.sprkl/bin/sprkl /usr/local/bin/sprkl
ln -sf $HOME/.sprkl/bin/sprkl-nodejs /usr/local/bin/sprkl-nodejs
It might require privileges. If so, try to run with
sudo
:sudo ln -sf $HOME/.sprkl/bin/sprkl /usr/local/bin/sprkl
sudo ln -sf $HOME/.sprkl/bin/sprkl-nodejs /usr/local/bin/sprkl-nodejs
Add the sprkl binaries directory to the
PATH
environment in your shell config. Usually $HOME/.bashrc
for bash
, and $HOME/.zshrc
for zsh
, etc.export PATH="$PATH:$HOME/.sprkl/bin"
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
sprkl cloud activate --cloud.token=$TOKEN --cloud.id=$ID
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.

Post installation: VSCode (left), Web (right)
Following that, you can choose between bare metal, Docker, or running Sprkl with Kubernetes, if you're working with Kubernetes on your development environments.
Last modified 6mo ago