documentation

project test

Run the project locally to verify it works before uploading.

cycle project test [dir] [-e KEY=val] [-r | -c] [--skip-limits]

Arguments:

  • dir: Project directory. If omitted, the CLI searches up from the current directory through parent directories for the nearest project manifest.

Options:

  • -e, --env: Set an environment variable (repeatable). These are merged with the env vars in the manifest's [job] section; if the same key appears in both, the -e value wins.
  • -r, --rebuild: Re-run the build script on top of the previous build image, even if nothing changed.
  • -c, --clean: Discard all cached build layers and start from a fresh base image.
  • --skip-limits: Disable memory and PID limits on the container. By default, containers are capped at 90% of system memory and 4096 processes, same as production jobs. Use this flag if your job needs more resources than the default limits allow.

--rebuild and --clean cannot be used together.

Output location:

Artifacts are saved to .cycleswap/tests/<YY-MM-DD_HH-MM-SS>/ using your local time.

Examples:

cycle project test
cycle project test -e MODEL=resnet -e EPOCHS=5
cycle project test --skip-limits
cycle project test --clean