CtrlB
  • CtrlB Flow
    • 🖐️Introducing CtrlB Flow
    • 🏁Getting started
    • Getting data in CtrlB Flow
    • Explore your data
    • Control your data
  • CtrlB Live Debug
    • 🖐️Introducing CtrlB Live Debug
      • What can you do with CtrlB?
      • How CtrlB works?
    • 🏁Getting started in 2 minutes
    • Plugins
      • Visual Studio Code
      • PyCharm, IntelliJ & WebStorm
    • Agents
      • Python
        • Installation
        • Configuration
        • System Requirements
        • Data Redaction
        • Troubleshoot / Release Notes
          • Version 1.0
      • NodeJs
        • Installation
        • Configuration
        • System Requirements
        • Data Redaction
        • Troubleshoot / Release Notes
          • Version 1.0
      • Java
        • Installation
        • Run with IntelliJ
        • Configuration
        • System Requirements
        • Data Redaction
        • Troubleshoot / Release Notes
      • Go
        • Installation
        • Run with Goland
        • Run with Docker
        • Configuration
        • System Requirements
        • Data Redaction
    • 🎛️Conditional Expressions
    • 🏭Deploy within your firewall
    • 🍉Benchmarking impact on your system
      • Java
      • Go
    • Benchmarking impact on your system:
Powered by GitBook
On this page
  1. CtrlB Live Debug
  2. Agents
  3. NodeJs

Installation

PreviousNodeJsNextConfiguration

Last updated 1 year ago

  1. Our node agent can be installed from npm.

npm install @ctrlb/heimdall
  1. Once installed, import our agent at the top of your code as follows.

JS example
const heimdall = require('@ctrlb/heimdall');

heimdall.start({ 
    apiKey: '<Your_Api_Key>'
});
TS example
import * as heimdall  from '@ctrlb/heimdall';

heimdall.start({ 
    apiKey: '<Your_Api_Key>'
});

You can get your API key by clicking the user profile icon > Profile in IDE plugin.

Other configuration parameters can also be specified as mentioned in .

  1. Now you can run your application as you usually would like

node app.js

Do go through to read more about current possibilities and limitations.

configuration
Release Notes