Skip to main content
Reference
List, inspect, create, and delete Helix Cloud projects, and link the current helix.toml to one. Cloud only.

Usage

Bare helix project lists projects with the defaults below. Flags go after the subcommand: helix project list --workspace <workspace>, not helix project --workspace <workspace>.

Subcommands

Arguments

Options

Behavior

  • Arguments and defaults resolve as described in Cloud resource resolution. A project slug or name without --workspace is searched for in every workspace you can access.
  • list marks the project linked in helix.toml.
  • link and create --link need a helix.toml with at least one instance (run helix init local first). They write [project] id and workspace_id, rewriting the file and dropping its comments (see Commands that rewrite helix.toml). They keep the local [project] name, which names local containers, and create no global selection state. link ignores an existing link, so it can relink a directory.
  • get and list --json show each project’s id, which helix service-credential --grant needs.
  • delete asks for confirmation in a terminal. Without one, or with --json, it fails before any request unless you pass --yes. It deletes the named or linked project only; it never picks a workspace’s only project on its own. With --json it prints {"deleted":{"kind":"project","id":"..."}}.
  • project update is not supported.

Examples