Just

just is the project's task runner. It provides a consistent interface for building, running and cleaning the project.

tip

To see every available command at any time, run:

Show available Just commands

just help

Commands are grouped by subsystem and follow the pattern just <subsystem> <action> (for example just cmake build or just js clean). To list only one subsystem's commands, run just <subsystem> help (for example just cmake help).

Initialise the project

info

If you have already run just init before (like when following the Project Setup Guide), you don't need to run it again.

There is no harm in re-running it, though.

Run this once after cloning the repository.

Paste this in the Docker shell

just init

This:

• Pulls the required Git submodules.
• Installs project dependencies.
• Builds the entire project.

Build the project

Everything

Build Everything (C++, C, JS, WASM, Python, React App, ...).

Paste this inside the Docker shell

just build-all

C++ and C

Build C++ Core and C Bindings.

This is CMake-based with GCC / MSVC.

build-c-cpp/ CMake build folder.

Paste this inside the Docker shell

just cmake build

Key files:

• CMakeLists.txt
• core/CMakeLists.txt.
• bindings/c/CMakeLists.txt.

JS / WASM

Build JavaScript / WASM Bindings.

This is CMake-based with Emscripten (to compile to WebAssembly).

• build-wasm/ CMake build folder.
• packages/js/build-wasm/ copied folder (from build-wasm/).

Paste this inside the Docker shell

just js build

Key Files:

• CMakeLists.txt
• bindings/js/CMakeLists.txt.

Build Browser & Node.js npm packages.

This is pnpm-based, yet it requires the outputs from the just js build command.

packages/js/dist folder.

Paste this inside the Docker shell

just js package

Key files:

• package.json
• pnpm-workspace.yaml
• packages/js/package.json
• packages/js/vite.config.js

Common Confusion

just js build only produces the raw WASM/JS bindings. To build the publishable img2num npm package — which targets both the browser and Node.js — run just js package. It compiles the WASM bindings first (so it works from a clean checkout) and then bundles the browser and Node builds into packages/js/dist/.

Python

Build Python Bindings + Wheel

This uses uv and scikit-build-core to build the Pybind11 Python bindings in bindings/py alongside the Python wrapper in packages/py.

dist folder.

Paste this inside the Docker shell

just py build

Key files:

• pyproject.toml
• packages/py/pyproject.toml
• CMakeLists.txt
• bindings/py/CMakeLists.txt.

Documentation

Build

Build the documentation:

Paste this in the Docker shell

just docs build

Server

Start the documentation server:

Paste this in the Docker shell

just docs start

Clean

Remove the generated documentation files:

Paste this in the Docker shell

just docs clean

Example applications

Build first

Excluding the React.js example application, the respective projects must be built first before you can run them or see the latest changes you made.

C++ console app

Run it

just console-cpp <path-to-image>

C console app

Run it

just console-c <path-to-image>

React.js web app

Run it

just react-js start

Next open http://localhost:5173/example-apps/react-js/ in your browser.

Python console app

Run it

just console-py <path-to-image>

Node.js console app

Run it (CommonJS)

just console-js-cjs <path-to-image>

Run it (ES modules)

just console-js-esm <path-to-image>

Cleaning

Remove generated build files:

Everything

Removes every generated build folder below (and the cleaned documentation files).

Paste this inside the Docker shell

just clean-all

C++

Paste this inside the Docker shell

just cmake clean

JS / WASM

Paste this inside the Docker shell

just js clean

JS Packages

Paste this inside the Docker shell

just js package-clean

Python Packages

Paste this inside the Docker shell

just py clean