CLI aura — 完整参考
官方 aura 二进制文件允许您控制整个 Aurabase 平台:本地开发、Kubernetes、SQL 迁移、存储函数、Edge Functions WASM、 RLS、存储和身份验证。
独立的二进制文件,随处可用#
CLI 是一个独立的 Rust 二进制文件。今天,它由 NPM 安装在 macOS Apple Silicon 上,并通过其他地方的源进行编译。适用于 Linux、macOS Intel 和 Windows 的预编译二进制包尚未发布:npm install -g @aurabase/cli 在那里失败,这不是您的错误。
# 1. NPM——截至目前仅适用于 macOS Apple Silicon
npm install -g @aurabase/cli
aura --help
# 2. 从源头开始 — 所有平台 (Rust 1.7x+)
git clone https://github.com/Aurabase-cloud/Aurabase.git
cargo install --path Aurabase/aura-cli
# 在 ~/.cargo/bin 中安装 `aurabase` 二进制文件
aurabase --help
验证 CLI#
您可以使用控制台帐户登录或使用 CI/CD 管道的个人访问令牌:
# 交互式登录(打开浏览器)
aura login
# 非交互式连接(电子邮件/密码)
aura login --email dev@example.com --password "secret"
# 通过个人访问令牌连接(非常适合 GitHub 操作/GitLab CI)
aura login --token aura_pat_9a8b7c6d5e4f...
# 检查帐户和活动项目
aura whoami
每个模块的详尽参考#
查找 aura 二进制文件支持的所有命令和子命令:
项目设置和管理
项目的初始化、连接和诊断
aura init— 初始化一个新的 Aurabase 项目(结构、配置、docker)aura login [--email <email>] [--password <pass>] [--token <pat>]— 登录控制台帐户或使用个人访问令牌aura register [--email <email>] [--password <pass>]— 创建新的 Aurabase 控制台开发者帐户aura logout— 断开活动的本地会话aura whoami— 显示登录的用户、其组织和活动项目aura link --project-id <uuid>— 将当前目录链接到现有云项目aura status— 显示项目状态、连接和服务状态aura doctor— 诊断本地环境(Docker、端口、系统工具)
当地发展
本地堆栈管理(Kubernetes / k3d)和日志
aura start— 启动 k3d 上的所有 Aurabase 本地微服务aura stop— 停止 k3d 集群和本地服务aura restart— 重新启动本地服务aura dev— 连续开发模式:监视迁移并同步类型aura studio— 在浏览器中打开本地 Studio 界面 (localhost:3000)aura logs [-s <service>] [--since 1h] [--tail 100]— 显示统一的或按服务过滤的日志(aura-auth、aura-db、网关...)aura connect— 在项目的直接 PostgreSQL 端点上打开交互式 psql 终端(psql 要求提供aura db connection --new-password发出的密码)
组织和云项目
组织和项目的多租户管理
aura orgs list [--json]— 列出您所属的组织aura orgs create --name <name> --slug <slug>— 创建新的云组织aura orgs use <slug>— 设置订单的默认组织aura projects list [--org <slug>] [--json]— 列出组织的项目aura projects create <name> [--engine postgres|mongodb] [--org <slug>]— 提供一个新项目aura projects delete <id>— 永久删除项目及其数据aura projects api-keys [--project-id <id>]— 显示项目的 API 密钥(anon、service_role)aura projects rename <id> <name>— 重命名现有项目aura projects retry <id>— 在error中重新运行项目的配置,并在准备就绪后打印其 URL 和密钥aura projects graphql-enable <id> [--wait]— 在项目上启用 GraphQL 扩展 (pg_graphql)aura projects graphql-config <id> [--introspection on|off] [--max-rows N] [--inflect-names on|off] [--wait]— 显示或更改 pg_graphql 设置(没有标志,打印有效的设置)
数据库分支(aura分支)
分支是从 PostgreSQL 项目克隆的新项目,具有自己的 URL 和密钥,在其 TTL 结束时删除。请参阅 数据库分支 了解限制和克隆内容。
aura branch create <name> [--from <project id|slug|name>] [--org <slug>] [--ttl 72h|3d|2w] [--no-data] [--no-wait] [--json] [--timeout <s>]— 创建链接项目(或--from)的分支,等待其准备就绪,然后打印其 URL 及其 API 密钥一次。--ttl从 1 小时到 30 天(默认 72 小时)。--no-data仅复制架构aura branch list [--from <project>] [--all] [--json]— 列出项目的分支,或使用--all列出整个组织的分支;失败的分支会在列表中保留 24 小时并附上原因aura branch delete <name> [--from <project>] [--force]— 删除分支及其数据库
数据库和迁移 (aura db)
模式管理、同步、推/拉和 SQL 查询
aura db push— 应用待处理的本地 SQL 迁移(+ 云同步(如果已链接))aura db pull— 检索远程模式并更新本地模式aura db diff [--name <name>]— 将远程模式与本地模式进行比较并生成 SQL 迁移aura db status [--json]— 显示已应用和待处理迁移的详细状态aura db watch— 监控架构更改并实时同步aura db reset [--force]— 从头开始清除并重新创建本地数据库(要求确认;脚本为--force)aura db seed— 运行 Seed.sql 脚本来加载测试数据aura db generate [--lang ts|rust]— 生成 TypeScript (默认)或 Rust 数据库类型定义aura db extensions list [--json]/aura db extensions enable <name>— 列出已安装的扩展,或启用允许的扩展aura db inspect <indexes|tables|locks> [--json]— 索引使用情况(标记未使用的索引)、表大小和死行、阻塞锁aura db slow-queries [--limit <n>] [--json]— 通过pg_stat_statements列出最慢的 SQL 查询aura db stats [--json]— 显示连接统计信息和数据库磁盘使用情况aura db connection [--new-password] [--yes] [--json]— 直接 PostgreSQL 访问(psql、Prisma、Drizzle、pg_dump):主机、端口、数据库和角色;使用--new-password,发出密码(显示一次,从不以明文形式存储,撤销前一个密码)并打印完整的连接字符串aura db raw "<sql>" [--params <p1> <p2>] [--dry-run] [--read-only] [--json]— 使用模拟和只读选项运行直接 SQL 查询aura db migration new <name>— 创建一个新的带时间戳的 SQL 迁移文件aura db migration list [--json]— 列出所有项目迁移及其状态aura db migration down [n]— 取消最近应用的 n 次迁移(默认值:1)aura db migration repair <file> [--applied|--reverted]— 在项目的迁移历史记录中手动将迁移标记为已应用或取消(读取相同的历史记录aura db status和migration list)
RLS 表和策略(aura 数据库表/策略)
声明式创建、 RLS、实时 CDC 和权限
aura db table list [--json]— 列出公共模式表及其列和类型aura db table create <name> "<cols>"— 创建一个表(例如:“title:text,tags:text[],embedding:vector(1536)”)aura db table drop <name> [-f]— 删除表及其约束aura db table rls <name> <on|off>— 启用或禁用表上的行级安全保护aura db table realtime <name> <on|off>— 启用或禁用表上的实时 CDC 发布aura db policy list [--table <name>] [--all] [--json]— 列出表上定义的 RLS 安全策略(--all包括内部存储规则)aura db policy add <table> <name> <cmd> [--using-expr <expr>] [--check-expr <expr>]— 创建新的 RLS 策略(SELECT、INSERT、UPDATE、DELETE 或 ALL)aura db policy update <table> <name> [--using-expr <expr>] [--check-expr <expr>]— 修改规则的 USING/WITH CHECK 表达式而不破坏aura db policy delete <table> <name> [-f]— 删除 RLS 安全规则
Postgres SQL 函数和触发器(aura db 函数/触发器)
PL/pgSQL 存储过程和表触发器
aura db function list [--json]— 列出架构中的 Postgres 函数(名称、参数、安全性、权限)aura db function create <name> [--body <sql>|--body-file <f>] [--returns <t>] [--language plpgsql|sql] [--args <a:t>] [--security invoker|definer] [--grant-execute-to <roles>]— 创建或替换具有严格访问控制的存储 SQL 函数aura db function drop <name> [-f]— 删除 Postgres SQL 函数aura db trigger list <table> [--json]— 列出表中的所有触发器aura db trigger create <table> <name> --function <fn> [--timing before|after|instead_of] --events insert,update [--for-each row|statement]— 将触发函数绑定到表事件aura db trigger drop <table> <name> [-f]— 删除表上的触发器
备份和 API 密钥(aura 数据库备份/api 密钥)
访问令牌的快照、恢复和管理
aura db backup list [--json]— 列出数据库的手动和自动备份aura db backup create [--label <label>]— 生成数据库的即时快照aura db backup restore <id> [--verify-only] [--yes]—--yes(或--force)跳过脚本和 CI 中所需的确认;从指定快照恢复数据库aura db backup download <id> [-o <path>]— 下载备份的完整 SQL 转储aura db backup delete <id> [-f]— 删除备份存档aura db backup schedule get [--json]— 查阅配置的自动备份计划aura db backup schedule set [--frequency hourly|daily|weekly] [--retention-days <n>] [--enable|--disable]— 配置备份的频率和保留期限aura db apikeys list [--json]— 列出与项目关联的活动 API 密钥aura db apikeys create <name> [--scope anon|authenticated|service_role]— 生成具有特定角色的新 API 密钥aura db apikeys revoke <id> [-f]— 立即撤销 API 密钥
身份验证和用户(aura auth)
管理帐户、会话、审核日志和电子邮件模板
aura auth users list [--json]— 列出项目中注册的用户aura auth users create [--email <email>] [--password <pass>] [--json]— 创建一个带有密码的新用户(--json打印创建的用户及其id,用于脚本)aura auth users delete <id> [-f]— 永久删除用户aura auth users ban <id>— 禁止用户并撤销其活动会话aura auth users unban <id>— 取消禁止用户aura auth sessions list [--json]— 列出活动的 JWT 会话aura auth audit-log [--limit 50] [--json]— 查看安全审核日志和连接尝试aura auth settings get [--json]— 显示身份验证配置(OAuth、 MFA、超时)aura auth settings set KEY=VALUE...— 更新身份验证设置aura auth email-templates list [--json]— 列出电子邮件模板(确认、重置、魔术链接)aura auth email-templates get <type>— 显示模板的 HTML/文本源代码aura auth email-templates reset <type> [-f]— 将模板重置为默认值
边缘功能 WASM 和秘密(光环功能/秘密)
部署边缘功能和加密环境变量
aura functions new <name>— 生成新边缘函数的骨架aura functions deploy <name>— 编译为 WASM 二进制文件并将函数部署到全球网络aura functions list [--json]— 列出本地和已部署的函数及其状态aura functions logs <name>— 显示函数的实时日志流aura functions serve— 启动本地功能测试服务器aura functions invoke <name> [--data '<json>']— 调用并测试使用有效负载部署的函数aura functions download <name>— 下载远程函数的源代码aura functions delete <name> [-f]— 删除已部署的边缘功能aura secrets list --function <name> [--json]— 列出为函数配置的秘密变量aura secrets set --function <name> KEY=VALUE...— 定义注入函数的加密秘密aura secrets unset --function <name> KEY...— 从函数中删除一个或多个秘密
对象存储(aura存储)
存储桶管理和文件传输
aura storage ls [path]— 列出文件夹中的存储桶或文件aura storage cp <src> <dst>— 传输文件(本地 ↔ 存储桶)aura storage rm <path>— 删除存储在存储桶中的文件aura storage mb <name> [--public]— 创建一个新存储桶(默认为私有,或公共)aura storage buckets list [--json]— 列出项目中的所有存储桶aura storage buckets create <name> [--public]— 创建存储桶aura storage buckets delete <name> [-f]— 删除存储桶并清除其所有对象
当地环境和公用设施
.env 变量、TUI 界面、自动更新和自动完成
aura env list [--json]— 显示本地 .env 中定义的变量aura env set KEY=VALUE...— 在本地 .env 中设置一个或多个变量aura env unset KEY...— 从本地 .env 文件中删除变量aura ui— 启动完整的交互式 TUI(终端用户界面)aura update— 自动检查 CLI 并将其更新到最新的稳定版本aura completions <bash|zsh|fish|powershell|elvish>— 为您的 shell 生成自动完成脚本
终端交互界面#
Aurabase 集成了由 Ratatui 提供支持的文本模式界面 (aura ui)。它允许您在不离开终端的情况下导航数据库、执行 SQL、检查表并跟踪日志。
# 启动 TUI 界面
aura ui
全局选项和设置#
--json— 结构化 JSON 输出(非常适合脚本、jq 和 CI/CD 自动化)--dry-run— 在最后回滚的事务中执行命令以验证约束而不更改数据--read-only— 在 Postgres 引擎上将事务严格锁定为只读-f, --force— 忽略破坏性操作的交互式确认请求--project-id <uuid>— 针对特定的远程项目,忽略本地链接文件
在 shell 中启用自动完成功能以自动使用 Tab 键命令:aura completions zsh > ~/.zfunc/_aura 或 aura completions bash > /etc/bash_completion.d/aura。