CLIマニュアル

Azivault CLI

CLIインストーラーをダウンロードする

インストーラーパッケージをダウンロードし、開いて指示に従ってください。インストール後、Terminalでaziを実行してください。

azi.pkgをダウンロードするMac用Azivaultをダウンロードする

ここから始めましょう

短い概要については、引数なしでaziを実行するか、ファイルを作成する操作を行う前に、コマンド固有のヘルプを求めます。

azi
azi --help
azi restore --help

回復する前に必要なもの

リカバリパスワードはバックアップ対象のMacの外に保管してください。CLIはファイルを読み込むか、環境変数からパスワードを読み取ることができます。これは、コマンドにパスワードを直接入力するよりも安全です。

一般的な復旧フロー

これらのコマンドは、典型的なローカルリカバリを示します。バックアップを確認し、適切なプランを見つけて実行し、ファイルを閲覧または検索し、安全な場所へ復元します。

例では、リポジトリに/Volumes/Backup/AzivaultRepository、プランIDにpersonal-documents、実行IDに8を使用しています。実際のバックアップに表示されるパスとIDに置き換えてください。

azi info /Volumes/Backup/AzivaultRepository
azi list-plans /Volumes/Backup/AzivaultRepository
azi verify /Volumes/Backup/AzivaultRepository \
  --recovery-password-file ~/Documents/azivault-recovery-password.txt
azi list-runs /Volumes/Backup/AzivaultRepository \
  --plan personal-documents
azi list /Volumes/Backup/AzivaultRepository \
  --plan personal-documents \
  --run 8 \
  --path documents/taxes \
  --recovery-password-file ~/Documents/azivault-recovery-password.txt
azi search /Volumes/Backup/AzivaultRepository \
  --plan personal-documents \
  --run 8 \
  --name summary \
  --limit 10 \
  --recovery-password-file ~/Documents/azivault-recovery-password.txt
azi restore /Volumes/Backup/AzivaultRepository \
  --plan personal-documents \
  --run 8 \
  --path documents/taxes/summary.pdf \
  --to ~/Desktop/summary.pdf \
  --recovery-password-file ~/Documents/azivault-recovery-password.txt

1つのファイルではなく、実行からすべてを復元するには、クリーンなフォルダにエクスポートしてください。

azi export /Volumes/Backup/AzivaultRepository \
  --plan personal-documents \
  --run 8 \
  --to ~/Desktop/AzivaultExport \
  --recovery-password-file ~/Documents/azivault-recovery-password.txt

バックアップがS3互換ストレージにしかない場合は、まずhydrate-s3でリポジトリをローカルフォルダへ取得し、そのローカルコピーに対して同じコマンドを実行します。

export AWS_SECRET_ACCESS_KEY='SECRET_ACCESS_KEY'
azi hydrate-s3 /PATH/TO/HYDRATED_REPOSITORY \
  --bucket BUCKET_NAME \
  --region REGION \
  --endpoint S3_ENDPOINT \
  --path-style true \
  --access-key-id ACCESS_KEY_ID

azi verify /PATH/TO/HYDRATED_REPOSITORY \
  --recovery-password-file /PATH/TO/PASSWORD_FILE

azi export /PATH/TO/HYDRATED_REPOSITORY \
  --plan personal-documents \
  --run 8 \
  --to /PATH/TO/EXPORT_FOLDER \
  --recovery-password-file /PATH/TO/PASSWORD_FILE

次の値を置き換えます:

パスワードオプション

コマンドごとに復元パスワードオプションを1つ使用します。実際の復元時には、パスワードファイルが通常、最適な選択肢となります。

azi verify /Volumes/Backup/AzivaultRepository \
  --recovery-password-file ~/Documents/azivault-recovery-password.txt
export AZI_RECOVERY_PASSWORD='RECOVERY_PASSWORD'
azi search /Volumes/Backup/AzivaultRepository \
  --plan personal-documents \
  --run 8 \
  --name invoice \
  --recovery-password-env AZI_RECOVERY_PASSWORD
unset AZI_RECOVERY_PASSWORD

RECOVERY_PASSWORDをリポジトリの復旧パスワードに置き換えます。

グローバルオプション

次の表で、すべてのコマンドに共通するオプションを説明します。

オプションそれを使う
--helpまたは-h一般的なヘルプまたはコマンド固有のヘルプを表示します。
--versionインストールされたCLIバージョンを印刷します。
--jsonまたは--output jsonスクリプトとドライラン用の構造化された出力を返します。
--quiet成功したコマンドの出力を抑制する。
--no-colorテキスト出力でANSIカラーをオフにします。

発見コマンド

インストールされたCLIがサポートする機能について学ぶには、これらのコマンドを使用します。復元スクリプトを作成したり、エージェントにバックアップの検査を依頼したりする前に役立ちます。

azi commands --json
azi describe restore --json
azi agent-context --json

commandsは利用可能なコマンドのリストを示し、describeは1つのコマンドを説明し、agent-contextは自動呼び出し者向けの安全なワークフローガイダンスを印刷します。

バックアップ場所を確認する

ファイルを書き込まないコマンドから始めます。これにより、バックアップ場所が存在し、読み取り可能で、ロック解除可能であることを確認できます。

azi info /Volumes/Backup/AzivaultRepository
azi list-plans /Volumes/Backup/AzivaultRepository
azi verify /Volumes/Backup/AzivaultRepository \
  --recovery-password-file ~/Documents/azivault-recovery-password.txt

適切なプランを見つけて実行する

バックアップ場所には複数のプランが含まれる場合があります。list-plansを使用してプランIDを見つけ、次にそのプランの完了した実行をリストします。

azi list-plans /Volumes/Backup/AzivaultRepository
personal-documents    Personal Documents
photo-library         Photo Library

Macアプリは、プランを作成し、除外されたファイルとフォルダを管理します。ターミナルからこの構成を監査するには、JSON出力のリクエストを行います。各プランにはexclusionCountexclusionGlobsが含まれています。グローブルールは、バックアップエンジンで使用されるパス認識式ルールと同じです。

azi list-plans /Volumes/Backup/AzivaultRepository --output json
{
  "schemaVersion": 1,
  "command": "list-plans",
  "plans": [
    {
      "planID": "personal-documents",
      "name": "Personal Documents",
      "exclusionCount": 2,
      "exclusionGlobs": ["Caches/**", "*.tmp"]
    }
  ]
}
azi list-runs /Volumes/Backup/AzivaultRepository \
  --plan personal-documents

list-runsの最初の列は実行IDです。ファイルが削除、破損、または変更される前の実行を使用してください。

バックアップ実行時点のファイルを閲覧する

ファイル名は保護されているため、実行ファイルを閲覧するには復元パスワードが必要です。

azi list /Volumes/Backup/AzivaultRepository \
  --plan personal-documents \
  --run 8 \
  --recovery-password-file ~/Documents/azivault-recovery-password.txt
azi list /Volumes/Backup/AzivaultRepository \
  --plan personal-documents \
  --run 8 \
  --path documents/taxes \
  --recovery-password-file ~/Documents/azivault-recovery-password.txt

ファイルを検索する

ファイル名の一部は覚えていますが、正確なフォルダは覚えていない場合は、searchを使用します。

azi search /Volumes/Backup/AzivaultRepository \
  --plan personal-documents \
  --run 8 \
  --name invoice \
  --limit 10 \
  --recovery-password-file ~/Documents/azivault-recovery-password.txt

より予測可能なマッチングのために、検索モードを1つ追加してください:--exact--prefix、または--contains

1つのファイルを復元する

まず一時的な場所に復元します。Azivaultは、明示的に要求されない限り、既存の保存先のオーバー書きを拒否します。

azi restore /Volumes/Backup/AzivaultRepository \
  --plan personal-documents \
  --run 8 \
  --path documents/taxes/summary.pdf \
  --to ~/Desktop/summary.pdf \
  --recovery-password-file ~/Documents/azivault-recovery-password.txt

保存先を意図的に変更する場合は、--overwrite trueを追加してください。ファイルを書き込むことなく復元を確認したい場合は、まずドライランを使用してください。

azi restore /Volumes/Backup/AzivaultRepository \
  --plan personal-documents \
  --run 8 \
  --path documents/taxes/summary.pdf \
  --to ~/Desktop/summary.pdf \
  --dry-run \
  --output json \
  --recovery-password-file ~/Documents/azivault-recovery-password.txt

バックアップ実行全体をエクスポートする

バックアップ実行時点から復元可能なすべてのファイルとフォルダの完全なコピーを作成する場合は、exportを使用します。

azi export /Volumes/Backup/AzivaultRepository \
  --plan personal-documents \
  --run 8 \
  --to ~/Desktop/AzivaultExport \
  --recovery-password-file ~/Documents/azivault-recovery-password.txt

最も安全な動作を希望する場合は、新しいフォルダまたは空のフォルダにエクスポートします。一致するファイルを意図的に置き換える場合にのみ、--overwrite trueを追加してください。

オブジェクトストレージからのバックアップを更新する

唯一のコピーがS3互換ストレージにある場合は、まずローカルフォルダにハイドレーションしてください。ハイドレーション後、ローカルフォルダに対して通常のコマンドを実行してください。

export AWS_SECRET_ACCESS_KEY='SECRET_ACCESS_KEY'
azi hydrate-s3 /PATH/TO/HYDRATED_REPOSITORY \
  --bucket BUCKET_NAME \
  --region REGION \
  --endpoint S3_ENDPOINT \
  --path-style true \
  --access-key-id ACCESS_KEY_ID

大文字の値を、プロバイダーの認証情報、バケット、リージョン、エンドポイント、ローカル保存先のパスに置き換えます。

AWS S3の場合、AWS地域を使用し、プロバイダーからカスタムエンドポイントを提供されない限り、--endpointは省略してください。

export AWS_SECRET_ACCESS_KEY='SECRET_ACCESS_KEY'
azi hydrate-s3 /PATH/TO/HYDRATED_REPOSITORY \
  --bucket BUCKET_NAME \
  --region AWS_REGION \
  --access-key-id ACCESS_KEY_ID

エグジットコード

スクリプトはエグジットコードを確認する必要があります。JSONモードでは、失敗には機械で読み取れるエラーコードも含まれます。

次の表に終了コードを示します。

コード意味
0コマンドは成功しました。
1予期せぬエラーが発生しました。
2コマンドの情報が不足しているか、無効なオプションを使用しています。
3命令は明示的な承認なしにリスクの高い変更を行うことを拒否した。
4リクエストされたバックアップ項目またはメタデータが見つかりませんでした。
5バックアップの完全性検証に失敗しました。
6バックアップのロックが解除できなかったか、認証情報が拒否された可能性があります。
7ネットワークまたはストレージプロバイダーの操作に失敗しました。

安全に関する注意事項

関連ガイド

アプリベースの復元については、ファイル復元ガイド を参照してください。ストレージ設定については、S3対応バックアップガイド外部ドライブガイド を参照してください。

よくある質問

CLIを使用するには、Azivaultアプリが必要ですか?

いいえ。CLIは、Terminal を使用したい場合や、アプリが利用できない場合に回復や確認を行うために設計されています。Macアプリは、バックアッププランを作成および管理するのに最も簡単な方法です。

サブスクリプションの有効期限が切れた後でも、CLIでファイルを復元できますか?

はい。既存のバックアップは復元可能です。バックアップ場所と、バックアップを解除するために必要な復元パスワードへのアクセスは引き続き必要です。

リカバリパスワードをコマンドに直接入力すべきですか?

真の復旧作業にはそれを避けてください。パスワードがシェル履歴に保存されないように、パスワードファイルまたは環境変数を使用することをお勧めします。

CLIはS3対応ストレージから復元できますか?

はい。まず、remote backupをhydrate-s3を使用してローカルフォルダにコピーし、その後、そのローカルフォルダから確認、検索、復元、またはエクスポートします。