documentation
sign in→

project init

Initialize a new project in the given directory. Creates a manifest at .cycleswap/manifest.toml.

cycle project init [dir] [-n <name>] [-v <image-version>] [-t <template>]

Arguments:

  • dir: Directory to initialize (default: current directory)

Options:

  • -n, --name: Project name (prompted if omitted)
  • -v, --version: Ubuntu version, e.g. 24.04 (prompted if omitted)
  • -t, --template: Template name, e.g. plain, python, or pytorch (prompted if omitted)

Example:

cycle project init ./my-experiment -n my-experiment

After running project init, edit .cycleswap/manifest.toml to configure your run script and link any volumes.

Existing manifest detection

If the target directory already contains a manifest at .cycleswap/manifest.toml, project init reads the project name from it, registers the project with that name, and skips generating the manifest, build script, and run script. The version, template, and name flags are ignored in this case.

This is the expected path after examples clone, which creates a directory with a manifest already in place. Running project init on that directory registers the example as a project without overwriting any of the example's files.