helix project

​

Usage

helix project [list] [--workspace <workspace>]
helix project get [PROJECT] [--workspace <workspace>]
helix project create <NAME> [--slug <slug>] [--workspace <workspace>] [--link]
helix project delete [PROJECT] [--workspace <workspace>] [--yes]
helix project link [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 writes [project] id and workspace_id to the current project’s helix.toml. It keeps the local [project] name, which names local containers, and creates no global selection state. It ignores an existing link, so it can relink a directory.
• 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

# List projects in the linked or only workspace
helix project

# Create a project and link this directory to it
helix project create "Demo App" --link

# Link this directory's helix.toml to an existing project by slug
helix project link demo-app

# Delete a project without a prompt
helix project delete demo-app --yes

​

Related

• helix workspace — list your workspaces.
• helix database — manage the project’s databases.
• CLI configuration — how the link is stored in helix.toml.