build-convex

Build the Convex project from source. Use when a contributor wants to compile, test, or package Convex.

npx skills add https://github.com/convex-dev/convex --skill build-convex

Download ZIP GitHub

Build Convex

Build the Convex Maven project. Requires Java 21+ (JDK 25 recommended). The checked-in wrapper supplies the pinned Maven version.

Run every command from the repository root — that is already the working directory, so do not cd anywhere first. Use ./mvnw on Unix-like shells or .\mvnw.cmd in PowerShell so the build uses the pinned Maven version.

Parse $ARGUMENTS for a module name (any argument starting convex-), e.g. convex-core.

Fast incremental build

The default when no arguments are given:

./mvnw -B -T1C test

Build a single module

./mvnw -B -T1C test -pl <module> -am

-am also builds the modules that one depends on.

Final verification

Use a clean, sequential build before claiming work is done:

./mvnw -B clean install

For a single module's tests:

./mvnw -B -T1C test -pl <module> -am

Report the result — success or failure — and any errors, concisely. On failure, quote the first real compilation or test error rather than the Maven summary.

More skills from convex-dev

Create and manage fungible tokens on Convex. Use when the user wants to create a new token, check token balances, or manage token supply.

Index of the Convex Architecture Documents (CADs), the normative specifications for Convex. Use to find which CAD governs a subsystem before changing protocol,…

CAD3 encoding format — cells, embedded vs branch references, value IDs, validity rules. Use when working on encoders, decoders, serialisation, hashing or…

Resolve or register Convex Name System (CNS) names. Use when the user wants to look up a CNS name, register a new name, or update a name's target.

Use Convex DB — a lattice-backed SQL database. Use when helping users write queries, connect via JDBC or PostgreSQL clients, create tables, insert/query data,…

Convex Lisp language reference — CVM conventions, calling library code, actor definitions, juice and error codes. Use when writing or debugging CVM source for…

Deploy an actor (smart contract) to the Convex network. Use when the user wants to create a new on-chain actor with exported functions.

Orientation in the Convex ecosystem — what lives in which repository, where the specs and docs are, and which client libraries exist. Use when you need context…