关于 getting-started
面向 Acquia CLI 入门用户的指导技能,涵盖安装、OAuth 认证和常用命令,并说明一般云管理与流水线操作应使用的不同 CLI。
主要功能
- 01acli 多种安装方式
- 02OAuth 登录与身份核验
- 03应用关联与查询
- 04IDE 和 SSH 密钥设置
- 05区分 acli 与 pipelines-cli 的用途
适用场景
- 01首次安装 acli
- 02登录 Acquia 账户
- 03将本地项目关联到云应用
- 04创建 IDE 或配置 SSH
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ acquia/ acquia-skills --skill getting-started安装后在 Claude Code 中输入/getting-started确认已加载。
详细介绍
开始使用 Acquia CLI
本指南介绍安装、身份验证和第一个命令。
适用于:
- 首次安装 acli
- 使用 Acquia Cloud 进行身份验证
- 学习第一个 acli 命令
工具概览
Acquia Cloud 操作有两个独立的 CLI:
| 工具 | 用途 |
|---|---|
acli | 常规 Cloud 管理:应用程序、环境、IDE、SSH 密钥、代码/数据库同步 |
pipelines-cli | CI/CD 流水线操作:触发构建、查看作业状态、实时查看日志 |
所有与流水线作业相关的操作都使用 pipelines-cli。其他操作都使用 acli。
ACE 与 MEO
acli 服务于两种不同的托管产品,使用不同的命令前缀:
| 产品 | 命令前缀 | API |
|---|---|---|
| ACE(Acquia Cloud Enterprise)— 经典单站点托管 | acli api:* | V2 |
| MEO(Multi-site Enterprise Operations)— 多站点托管 | acli api:v3:* | V3 |
如果你使用的是 MEO 订阅,请参阅 MEO 概览,了解完整命令集。
安装
macOS 和 Linux
选项 1:原生二进制文件(推荐)
原生二进制文件无需安装 PHP,可在任何现代 macOS 或 Linux 系统上运行。
# Download the latest release
curl -fsSL https://github.com/acquia/cli/releases/latest/download/acli \
-o /usr/local/bin/acli
# Make it executable
chmod +x /usr/local/bin/acli
# Verify it works
acli --version
选项 2:PHP 归档文件(PHAR)
如果你更喜欢使用 PHP,或已经安装了 PHP 8.2:
curl -fsSL https://github.com/acquia/cli/releases/latest/download/acli.phar \
-o /usr/local/bin/acli.phar
chmod +x /usr/local/bin/acli.phar
# Use as:
acli.phar --version
# Or create an alias
alias acli='acli.phar'
使用 Homebrew(macOS)
brew tap acquia/cli
brew install acli
acli --version
第一个命令:身份验证
Acquia CLI 使用 OAuth 对你的 Acquia 账户进行身份验证。只需执行一次。
acli auth:login
此操作将:
- 打开浏览器
- 提示你授权 Acquia CLI
- 生成访问令牌
- 将令牌加密后保存在本地
~/.acquia/cloud_api/credentials.json
令牌有效期为 30 天。 如果令牌过期,请再次运行 acli auth:login。
验证身份验证
acli auth:me
显示你的姓名、电子邮件和账户信息。
第一个命令:列出应用程序
查看你有权访问的应用程序:
acli api:applications:list
输出:
Select a Cloud Platform application:
[0] My First App (prod, staging, dev)
[1] Client Project (prod, staging)
[2] Development App (dev)
Shell 补全
启用 Tab 补全,加快命令输入。
Bash
eval "$(acli shell:complete bash)"
添加到 ~/.bashrc 以永久生效:
echo 'eval "$(acli shell:complete bash)"' >> ~/.bashrc
source ~/.bashrc
Zsh
eval "$(acli shell:complete zsh)"
添加到 ~/.zshrc:
echo 'eval "$(acli shell:complete zsh)"' >> ~/.zshrc
source ~/.zshrc
Fish
acli shell:complete fish | source
添加到 ~/.config/fish/config.fish:
acli shell:complete fish | source
获取帮助
命令帮助
每条命令都内置了帮助页面:
# General help
acli --help
acli -h
# Help for a specific command
acli ide:create --help
acli ide:create -h
# List all available commands by category
acli list
详细输出
调试时,可显示详细输出:
# -v (normal), -vv (detailed), -vvv (very detailed)
acli ide:list -vvv
acli ide:create -v
调试模式
在调试模式下运行任意命令,以查看后台运行详情:
acli ide:create --debug
配置
配置文件位置
配置存储在:~/.acquia/
~/.acquia/
├── cloud_api/
│ └── credentials.json # Your API token (encrypted)
├── config.yaml # Settings
└── cache/ # Cached data
关联本地项目
在项目目录中运行 acli app:link,将项目与 Cloud 应用程序关联。详情请参阅 应用程序管理。
常见的入门步骤
步骤 1:进行身份验证
acli auth:login
acli auth:me
步骤 2:设置项目
cd /path/to/project
acli app:link
步骤 3:创建 IDE(或连接到现有 IDE)
acli ide:create # Create a new one
# OR
acli ide:list # Connect to existing
步骤 4:设置 SSH
acli ssh-key:list # See your SSH keys
# If no keys, create one
acli ssh-key:create
步骤 5:尝试运行 Drush 命令
acli remote:drush status
acli remote:drush cr # Clear caches
故障排除
“Command not found: acli”
确保二进制文件位于你的 PATH 中。尝试:
which acli
# If nothing, add to PATH
export PATH="/usr/local/bin:$PATH"
acli --version
“Error: Failed to authenticate”
令牌已过期或无效。尝试:
acli auth:login
“Error: Access denied”
你没有权限访问该应用程序或资源。请检查:
- 你是否使用正确的 Acquia 账户登录?
- 你在 Acquia Cloud UI 中是否拥有相应权限?
运行 acli auth:me,确认使用的是正确的账户。
需要更多帮助?
更多问题请参阅故障排除指南。
Acquia Site Factory(ACSF)身份验证
如果你的组织使用 Acquia Site Factory,请注册单独的凭据:
acli auth:acsf-login
选项:
acli auth:acsf-login \
--username=myuser \
--key=MY_API_KEY \
--factory-url=https://www.myfactory.com
要注销:
acli auth:acsf-logout
缓存管理
清除本地 acli 缓存(命令行为异常时很有用):
acli self:clear-caches
别名:acli cc、acli cr
遥测
acli 默认会收集匿名使用数据,以帮助改进工具。如需选择退出:
acli self:telemetry:disable
如需重新启用:
acli self:telemetry:enable
交互式切换:
acli self:telemetry:toggle
别名:acli telemetry
打开产品文档
在浏览器中打开 Acquia 产品文档:
acli docs
针对特定产品:
acli docs acli
acli docs cloud-ide
最佳实践
- 先进行身份验证 — 首先运行
acli auth:login;大多数命令都需要身份验证。 - 发现命令 — 使用
acli list查看按主题分组的所有可用命令。 - 启用 Shell 补全 — 运行一次
acli shell:complete,即可对命令和标志进行 Tab 补全。 - 验证设置 — 运行
acli self:info,确认已通过身份验证的身份和 acli 版本。 - 保持更新 — 定期运行
acli self:update,以获取错误修复和新功能。 - 遇到异常行为时清除缓存 — 如果命令返回意外结果,请运行
acli self:clear-caches。
后续步骤
完成设置后,可以尝试:
- 创建你的第一个 IDE — 设置开发环境
- 探索应用程序 — 了解你的应用
- 设置 SSH 密钥 — 安全地进行身份验证