-
Notifications
You must be signed in to change notification settings - Fork 0
Build Command
build is the main cr4te command. It reconciles metadata and renders the static site.
cr4te build -i path/to/Creators -o path/to/sitecr4te build -i path/to/Musicians -o path/to/site --domain music
cr4te build -i path/to/Artists -o path/to/site --domain art
cr4te build -i path/to/Creators -o path/to/site --strict
cr4te build -i path/to/Creators -o path/to/site --clean --force
cr4te build -i path/to/Creators -o path/to/site --open-
-i,--input: path to the creator folder. -
-o,--output: path to the generated site folder.
The input and output paths must be different. The output path cannot be inside the input path, and the input path cannot be inside the output path.
-
--config: load a JSON config file. -
--domain: apply a domain preset. -
--image-sample-strategy: choosenone,spread,head, orall. -
--portrait-strategy: choosenone,named, orauto.
-
--themes-dir: include custom theme CSS files from the selected folder.
Relative paths resolve from the current working directory. The folder must exist and be a directory; otherwise the build aborts before changing metadata or output files.
See Custom Themes for theme file rules and examples.
-
--strict: fail immediately on invalid metadata instead of skipping/reporting invalid entries. -
--open: openindex.htmlafter a successful build. -
--force: skip confirmation prompts. -
--clean: when clearing an existing output folder, also deletethumbnails.
If the output folder already exists, cr4te asks before clearing it.
By default, it preserves the thumbnails folder so rebuilds can reuse generated thumbnails. Use --clean to remove thumbnails too.
Use --force when running non-interactively:
cr4te build -i path/to/Creators -o path/to/site --forceAt the end of a build, cr4te logs a summary:
Build summary: creators=15, projects=17, errors=0, warnings=0
If best-effort mode encountered issues, they are listed with severity, scope, relative path, issue code, and message.
Render-time asset problems also appear in this summary. Recoverable asset failures do not leave known-broken references in the generated site:
- Missing media and unreadable text or gallery images are omitted.
- Failed portrait and cover thumbnails use generated defaults.
- Unavailable optional inspection data, such as audio duration, uses a safe fallback and produces a warning.
Repeated failures with the same asset path and issue code are reported once per build.
Default behavior is best-effort:
- Invalid creator metadata skips that creator.
- Invalid project metadata skips only that project.
- Recoverable asset failures use safe fallbacks or omit the affected media item.
- Warnings, such as unknown collaboration references, are reported.
Strict behavior:
cr4te build -i path/to/Creators -o path/to/site --strictWith --strict, metadata and asset errors fail immediately. Asset warnings continue.
Print the resolved config:
cr4te print-config
cr4te print-config --domain musicDelete metadata files:
cr4te clean-json -i path/to/Creators --dry-run
cr4te clean-json -i path/to/Creators --forceUse --dry-run before deleting metadata files.