Reference
List, inspect, create, and delete Helix Cloud projects, and link the current helix.toml to one.
Cloud only.
Usage
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
--workspaceis searched for in every workspace you can access. listmarks the project linked inhelix.toml.linkandcreate --linkneed ahelix.tomlwith at least one instance (runhelix init localfirst). They write[project] idandworkspace_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.linkignores an existing link, so it can relink a directory.getandlist --jsonshow each project’sid, whichhelix service-credential --grantneeds.deleteasks 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--jsonit prints{"deleted":{"kind":"project","id":"..."}}.project updateis not supported.
Examples
Related
helix workspace— list your workspaces.helix database— manage the project’s databases.- CLI configuration — how the link is stored in
helix.toml.