documentation
sign in→

project init

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

squadron 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:

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

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

Existing manifest detection

If the target directory already contains a manifest at .squadron/manifest.toml, project init will read the project name from it, register the project under that name, and skip generating the manifest, build script, and run script. It ignores the version, template, and name flags in that case.

This is the expected path after examples clone, which leaves you with a directory that already has a manifest. Run project init there and it will register the example as a project without overwriting any of its files.