コンテンツへスキップ
オーラベースのロゴ
オーラベース

CLI オーラ — 完全なリファレンス

公式の aura バイナリを使用すると、ローカル開発、Kubernetes、SQL 移行、ストアド関数、 Edge Functions WASM、 RLS、ストレージ、および認証など、 Aurabase プラットフォーム全体を制御できます。

リファレンス12 分 読み取りレベル 参照2026/08/19 に改訂

このページは自動翻訳されました。英語版が正式です。

どこでも利用できるスタンドアロンのバイナリ#

CLI はスタンドアロンの Rust バイナリです。これは現在、macOS Apple Silicon 上の NPM によってインストールされ、他の場所のソースからのコンパイルによってインストールされます。 Linux、macOS Intel、および Windows 用のプリコンパイル済みバイナリ パッケージはまだリリースされていません。npm install -g @aurabase/cli はそこで失敗します。これはユーザー側のエラーではありません。

terminalbash
# 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
#    `aurabase` バイナリを ~/.cargo/bin にインストールします
aurabase --help

CLIを認証する#

コンソール アカウントでログインすることも、CI/CD パイプラインのパーソナル アクセス トークンを使用してログインすることもできます。

terminalbash
# 対話型ログイン (ブラウザを開く)
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 プロジェクト (構造、構成、ドッカー) を初期化します。
  • 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 キーを 1 回出力します。 --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 db テーブル/ポリシー)

宣言的作成、 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 db バックアップ / 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 認証)

アカウント、セッション、監査ログ、電子メールテンプレートの管理

  • 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 関数 / シークレット)

エッジ機能と暗号化された環境変数の導入

  • 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... — 関数から 1 つ以上のシークレットを削除します

オブジェクトストレージ(オーラストレージ)

バケット管理とファイル転送

  • 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 に 1 つ以上の変数を設定します
  • aura env unset KEY... — ローカルの .env ファイルから変数を削除する
  • aura ui — 完全な対話型 TUI (ターミナル ユーザー インターフェイス) を起動します。
  • aura update — CLI を自動的にチェックし、最新の安定したバージョンに更新します
  • aura completions <bash|zsh|fish|powershell|elvish> — シェルの自動補完スクリプトを生成します

端末内の対話型インターフェース#

Aurabase は、Ratatui を利用したテキスト モード インターフェイス (aura ui) を統合します。これにより、ターミナルを離れることなく、データベースの移動、SQL の実行、テーブルの検査、ログの追跡が可能になります。

terminalbash
# TUIインターフェイスを起動します
aura ui

グローバルオプションと設定#

  • --json — 構造化された JSON 出力 (スクリプト、jq、CI/CD の自動化に最適)
  • --dry-run — 最後にロールバックされたトランザクションでコマンドを実行し、データを変更せずに制約を検証します。
  • --read-only — Postgres エンジンでトランザクションを厳密に読み取り専用にロックします。
  • -f, --force — 破壊的な操作に対する対話型の確認要求を無視します。
  • --project-id <uuid> — ローカル リンク ファイルを無視して、特定のリモート プロジェクトをターゲットにします
ヒント

シェルでオートコンプリートを有効にして、コマンドを自動的にタブ化します:
aura completions zsh > ~/.zfunc/_aura または aura completions bash > /etc/bash_completion.d/aura。

さらに進むには#