Export

elek export writes Project content out to plain JSON - a self-contained snapshot you can consume statically, feed into other tools, or check into another repository. Unlike the local API and generated client, an export needs nothing running afterwards.

CLI

elek export [outDir] [projects] [template] [--watch]

What an export contains

Each Project is exported with its content inlined as assets, components and collections on the Project object, each Collection carrying its own entries. The nested template makes all four objects keyed for lookup rather than arrays:

The separate template writes the same content as arrays in its own files instead, see below.

References inside Entry values are kept as ids, not resolved - a consumer cross-references them against the exported Assets and Entries. Every object keeps its full metadata envelope (id, coreVersion, created, updated, and so on).

Whether the actual Asset binaries are included depends on the template.

nested template

Everything goes into a single JSON file, binaries excluded (Asset metadata keeps its original absolutePath).

• One Project: {outDir}/project-{projectId}.json
• Multiple Projects: {outDir}/projects.json, an object keyed by Project id.

Best when you want one file to load and walk in memory.

separate template

Each Project becomes a folder tree, and Asset binaries are copied in (with each Asset’s absolutePath updated to point at the copied file):

{outDir}/project-{projectId}/
|-- project.json
|-- assets/
|   |-- {assetId}.{extension}     copied binary
|   |-- assets.json               all asset metadata
|-- components/
|   |-- {componentSlug}.json      one per Component
|   |-- components.json           all Components
|-- collections/
|   |-- collections.json          all Collections
|   |-- {collectionSlugPlural}/
|   |   |-- collection.json
|   |   |-- entries.json          all Entries in the Collection

Best when you want browsable files and the binaries alongside them.

Selecting Projects

all exports every local Project. A comma-separated list of ids exports just those (each id is validated as a UUID).

Watch mode

--watch keeps the export current: it watches the Projects directory (ignoring .git) with chokidar and re-runs the same export on any change. Useful as a background step while developing against the exported JSON.

See also

• storage-layout.md - the on-disk source the export reads from
• local-api.md - reading content over HTTP instead of exporting
• api-clients.md - generating a typed client over the API
• concepts.md - the objects that appear in an export