documentation

examples clone

Clone an example project into the current directory. The cloned directory includes a .cycleswap/ with a manifest, build script, and run script already set up.

cycle examples clone <name>

Arguments:

  • name: Name of the example (required). Available examples: hello-world, stable-diffusion-ddp

The command fails if a directory with the example's name already exists.

Example:

cycle examples clone hello-world && cd hello-world

What happens on clone

The cloned project gets a randomized project name (the example's base name plus a random suffix, like hello-world-autumn-waterfall) so that multiple users can clone the same example without name collisions.

After cloning, run project init from inside the cloned directory to register the project. Because the directory already has a manifest, init uses the existing configuration and skips the interactive prompts.

cycle examples clone hello-world
cd hello-world
cycle project init
cycle project test
cycle project upload