Compiling Amplitude Project
Note
You will need to have an Amplitude project to follow these instructions. am project init scaffolds one for you — see the am CLI reference — or read the project setup documentation to create one by hand. You can also get one of the sample projects provided in the GitHub repository.
As explained in the project architecture documentation, an Amplitude project is mainly based on JSON files. Before the engine can load them, they need to be compiled into binaries — the .ambank, .ampipeline, and other files the rest of this documentation refers to.
Building a project¶
From the project's root directory, run:
This validates every asset in the project, then compiles them into binaries, in the project's build directory by default. Validation runs first regardless — pass --fail-fast to stop at the first error instead of collecting every validation failure before compiling.
| Flag | Description |
|---|---|
-o, --output <dir> | Build into <dir> instead of the project's default build directory. |
--clean | Remove existing build output before generating new files. |
--fail-fast | Stop on the first validation error instead of continuing. |
am project build reads the FlatBuffers schemas it needs straight from the SDK — set AM_SDK_PATH to your SDK installation, and no separate flatc install is required.
To check a project without building it, use am project validate; see the am CLI reference for its options.