安装
要安装 CLI，您需要安装 Python 和 pip。然后，您可以运行
pip install aura-cli
下载并安装 CLI。与其他 Python 库一样，您应该考虑在虚拟环境中安装它。
用法
安装后，aura 命令将在您的终端中可用。您可以通过运行 aura --version 或 aura --help 来验证安装是否成功。
凭据
需要在控制台中创建 Aura API 凭据（请参阅Aura API 文档）。然后，可以通过 aura credentials add 命令将其添加到 CLI。然后，凭据将保存在本地配置文件中。您可以添加多个凭据并在它们之间切换。
要添加您的第一个凭据，请运行
aura credentials add --name <NAME> --client-id <YOUR_CLIENT_ID> --client-secret <YOUR_CLIENT_SECRET> --use
以下是所有凭据命令的列表
-
aura credentials add -
aura credentials list -
aura credentials current -
aura credentials use -
aura credentials delete
如果设置了客户端 ID 或客户端密钥的环境变量，则将覆盖已配置的凭据。
环境变量
可以设置 8 个环境变量以在 CLI 中使用
-
AURA_CLI_AUTH_URL- 用于获取身份验证令牌的 URL（默认为https://api.neo4j.io/oauth/token） -
AURA_CLI_BASE_URL- 用于所有 API 调用的基本 URL（默认为https://api.neo4j.io/v1） -
AURA_CLI_CLIENT_ID- 用于身份验证的客户端 ID -
AURA_CLI_CLIENT_SECRET- 用于身份验证的客户端密钥 -
AURA_CLI_CONFIG_PATH- CLI 配置文件的路径。默认为~/.aura/config.json -
AURA_CLI_OUTPUT- 默认输出格式。默认为json。 -
AURA_CLI_SAVE_LOGS- CLI 日志是否保存到文件的标志。默认为false。 -
AURA_CLI_LOG_FILE_PATH- 保存日志的文件的路径。默认为~/.aura/auracli.log。
设置环境变量将覆盖使用 aura config set 命令设置的任何配置。
配置
aura config 命令允许设置配置和默认值。当前有 6 个选项可以使用 aura config set 命令设置
-
default_tenant- 用于命令（如aura instances create（其中需要租户 ID））的默认租户 -
output- API 命令的默认输出格式（json、text 或 table） -
auth_url- 用于获取身份验证令牌的 URL（默认为https://api.neo4j.io/oauth/token） -
base_url- 用于所有 API 调用的基本 URL（默认为https://api.neo4j.io/v1） -
save_logs- 是否将 CLI 日志保存到日志文件中。默认为 false。允许的值：“true”、“yes”、“false”、“no” -
log_file_path- 保存日志的文件的路径。默认为~/.aura/auracli.log
所有配置命令的列表
-
aura config get -
aura config list -
aura config set -
aura config unset
API 命令
API 命令分为 3 个资源：instances、tenants 和 snapshots。使用 --help 标志获取有关每个子命令的更多信息，例如 aura instances --help。
示例命令
aura instances get --name DevInstance
aura instances create --name DevInstance --cloud-provider gcp --region europe-west1 --type professional-db --tenant-id my-tenant-123
aura snapshots list --instance-id=b25d4b9f