Introduction to Oaklean

Oaklean helps you measure and understand energy and runtime behavior in Node.js and TypeScript projects.

With Oaklean, you can:

• profile source-level behavior with energy and performance signals,
• configure and standardize measurements with a .oaklean file,
• inspect reports directly in the Oaklean VS Code extension.

Get Started in 4 Steps

1. Install Oaklean packages for your use case:

npm install @oaklean/profiler

or for Jest-based test environments:

npm install @oaklean/profiler-jest-environment

2. Create a .oaklean configuration:

npm add --save-dev @oaklean/cli
npx oak init

3. Run your workload or test suite with Oaklean enabled to generate measurement output.

4. Open and analyze generated reports in the Oaklean VS Code Extension docs.

Documentation Map

• Fast configuration setup
• Config reference
• Sensor interfaces
• Interpret measurements
• VS Code extension overview