mcpField
G
getting-started

getting-started

github.com/acquiaクラウド・DevOps10106 回インストール今日更新
リポジトリ

getting-started について

Acquia CLI の導入を支援するガイドスキルです。インストール、OAuth 認証、基本コマンドを扱い、一般的なクラウド管理とパイプライン操作で使う CLI の違いも説明します。

主な機能

  1. 01acli のインストール方法
  2. 02OAuth ログインと本人確認
  3. 03アプリの関連付けと一覧表示
  4. 04IDE と SSH キーの設定
  5. 05acli と pipelines-cli の使い分け

活用シーン

  1. 01初めての acli のインストール
  2. 02Acquia アカウントへの認証
  3. 03ローカルプロジェクトとクラウドアプリの接続
  4. 04IDE の作成または 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 が 2 つあります。

ツール用途
acli一般的な Cloud 管理:アプリケーション、環境、IDE、SSH キー、コード/DB 同期
pipelines-cliCI/CD パイプラインの操作:ビルドの実行、ジョブの状態確認、ログのストリーミング

パイプラインのジョブに関する操作には pipelines-cli をお使いください。それ以外の操作には acli をお使いください。

ACE と MEO

acli は、コマンドのプレフィックスが異なる 2 種類のホスティング製品に対応しています。

製品コマンドのプレフィックス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 8.2 がすでにインストールされている場合、または 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

この操作により、次の処理が行われます。

  1. ブラウザーが開きます
  2. Acquia CLI の認証を求められます
  3. アクセストークンが生成されます
  4. トークンがローカルの ~/.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)

シェル補完

コマンドをすばやく入力できるよう、タブ補完を有効にします。

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

ベストプラクティス

  1. まず認証する — 何よりも先に acli auth:login を実行してください。ほとんどのコマンドで認証が必要です。
  2. コマンドを確認する — acli list を使用すると、トピックごとにグループ化された利用可能なコマンドをすべて確認できます。
  3. シェル補完を有効にする — acli shell:complete を一度実行すると、コマンドやフラグのタブ補完が利用できます。
  4. セットアップを確認する — acli self:info を実行して、認証済みの ID と acli のバージョンを確認します。
  5. 最新の状態を保つ — acli self:update を定期的に実行して、バグ修正や新機能を取り入れます。
  6. 動作がおかしい場合はキャッシュをクリアする — コマンドが予期しない結果を返す場合は、acli self:clear-caches を実行します。

次のステップ

セットアップが完了したので、次の操作を試してみてください:

コメント