Getting Started

Install Joule

One command. All platforms.

macOS

$ curl -fsSL https://joule-lang.dev/install.sh | sh

Linux

$ curl -fsSL https://joule-lang.dev/install.sh | sh

Windows

> irm https://joule-lang.dev/install.ps1 | iex

Quick Start

# Create a new project
$ joule new sensor_pipeline
$ cd sensor_pipeline

# Build with energy receipt
$ joule build
  Compiling sensor_pipeline v0.1.0
  Energy: 12.4 μJ (compute: 8.1, memory: 3.2, io: 1.1)
  Finished in 0.34s

# Run
$ joule run
  Hello from Joule!

# Run with energy profiler
$ joule run --energy-profile
  ┌─────────────────────┬──────────┐
  │ Function            │ Energy   │
  ├─────────────────────┼──────────┤
  │ main                │   5.2 μJ │
  │ process_data        │   4.1 μJ │
  │ io::write_line      │   3.1 μJ │
  └─────────────────────┴──────────┘

CLI Commands

joule new <name> Create a new project

joule build Compile with energy analysis

joule run Build and execute

joule check Type-check without codegen

joule test Run tests with energy receipts

joule bench Benchmark with energy comparison

joule fmt Format source code

joule doc Generate documentation

joule repl Interactive REPL with energy display