mcloud-projects

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Cloud CLI: Projects Commands

Cloud CLI:项目命令

Execute
mcloud projects
commands to manage Cloud projects.
执行
mcloud projects
命令来管理Cloud项目。

Constraints

约束条件

  • projects delete
    is irreversible — removes all associated environments, deployments, and resources. Always confirm the project ID/handle before deleting.
  • Use
    --yes
    with
    delete
    in non-interactive contexts (scripts, pipelines, agents).
  • projects delete
    操作不可撤销——会删除所有关联的环境、部署和资源。删除前务必确认项目ID/句柄。
  • 在非交互式场景(脚本、流水线、Agent)中执行
    delete
    命令时需添加
    --yes
    参数。

Commands

命令列表

projects list

projects list

List all projects in an organization.
bash
mcloud projects list --organization <org-id> --json
Options:
  • -o/--organization <id>
    — Organization ID (falls back to active context; required)
  • --json
    — Output as JSON
列出组织中的所有项目。
bash
mcloud projects list --organization <org-id> --json
选项:
  • -o/--organization <id>
    — 组织ID(默认使用当前活跃上下文;必填
  • --json
    — 以JSON格式输出

projects get

projects get

Retrieve a single project by its ID or handle.
bash
mcloud projects get <project-id-or-handle> --organization <org-id> --json
Arguments:
  • project
    — Project ID or handle (required)
Options:
  • -o/--organization <id>
    — Organization ID (falls back to active context; required)
  • --json
    — Output as JSON
通过项目ID或句柄获取单个项目的信息。
bash
mcloud projects get <project-id-or-handle> --organization <org-id> --json
参数:
  • project
    — 项目ID或句柄(必填)
选项:
  • -o/--organization <id>
    — 组织ID(默认使用当前活跃上下文;必填
  • --json
    — 以JSON格式输出

projects delete

projects delete

Delete a project by its ID or handle. Irreversible.
bash
mcloud projects delete <project-id-or-handle> \
  --organization <org-id> \
  --yes
Arguments:
  • project
    — Project ID or handle (required)
Options:
  • -o/--organization <id>
    — Organization ID (falls back to active context; required)
  • -y/--yes
    — Skip confirmation prompt (required in non-interactive mode)
  • --json
    — Output as JSON
通过项目ID或句柄删除项目。操作不可撤销。
bash
mcloud projects delete <project-id-or-handle> \
  --organization <org-id> \
  --yes
参数:
  • project
    — 项目ID或句柄(必填)
选项:
  • -o/--organization <id>
    — 组织ID(默认使用当前活跃上下文;必填
  • -y/--yes
    — 跳过确认提示(非交互式模式下必填)
  • --json
    — 以JSON格式输出

Project Fields (JSON)

项目字段(JSON格式)

FieldDescription
id
Project ID
handle
URL-safe project handle (used in most commands)
name
Display name
status
ready
when healthy
region
Deployment region (e.g.
us-east-1
)
repository
Linked GitHub repository (
owner/repo
)
root_path
Root path within the repository
environments
Array of associated environments
字段说明
id
项目ID
handle
URL安全的项目句柄(多数命令中使用)
name
显示名称
status
健康状态下为
ready
region
部署区域(例如
us-east-1
repository
关联的GitHub仓库(格式为
owner/repo
root_path
仓库内的根路径
environments
关联环境的数组

Examples

示例

bash
undefined
bash
undefined

List all projects in an organization

列出组织中的所有项目

mcloud projects list --organization org_123 --json
mcloud projects list --organization org_123 --json

Set context to a project by name

按名称设置项目上下文

PROJECT_HANDLE=$( mcloud projects list --organization org_123 --json
| jq -r '.[] | select(.name == "My Store") | .handle' ) mcloud use --project "$PROJECT_HANDLE"
PROJECT_HANDLE=$( mcloud projects list --organization org_123 --json
| jq -r '.[] | select(.name == "My Store") | .handle' ) mcloud use --project "$PROJECT_HANDLE"

Get project details including environments

获取包含关联环境的项目详情

mcloud projects get my-store --organization org_123 --json
mcloud projects get my-store --organization org_123 --json

List all environment handles for a project

列出项目的所有环境句柄

mcloud projects get my-store --organization org_123 --json
| jq -r '.environments[].handle'
mcloud projects get my-store --organization org_123 --json
| jq -r '.environments[].handle'

Find project handle by name

按名称查找项目句柄

mcloud projects list --organization org_123 --json
| jq -r '.[] | select(.name == "My Store") | .handle'
mcloud projects list --organization org_123 --json
| jq -r '.[] | select(.name == "My Store") | .handle'

Delete a project (irreversible — confirm before running)

删除项目(不可撤销——执行前请确认)

mcloud projects delete old-project --organization org_123 --yes
undefined
mcloud projects delete old-project --organization org_123 --yes
undefined