Перейти к содержимому
Логотип Аурабаза
аурабаза

CLI aura — Полная справка

Официальный двоичный файл aura позволяет вам контролировать всю платформу Aurabase: локальную разработку, Kubernetes, миграцию SQL, хранимые функции, Edge Functions WASM, RLS, хранилище и аутентификацию.

Справочник12 мин читатьУровень ссылкаПересмотрено 19 авг. 2026 г.

Эта страница была переведена автоматически. Английская версия является авторитетной.

Автономный двоичный файл, доступный везде.#

CLI представляет собой автономный двоичный файл Rust. Сегодня он установлен NPM на macOS Apple Silicon и путем компиляции из исходных кодов повсюду. Предварительно скомпилированные бинарные пакеты для 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 — запускает все локальные микросервисы Aurabase на k3d.
  • 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 — открывает интерактивный терминал psql на прямой конечной точке проекта PostgreSQL (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 (без флага печатает действующие настройки)

Ветки базы данных (ветвь ауры)

Ветка — это новый проект, клонированный из проекта PostgreSQL, со своим собственным URL-адресом и ключами, который удаляется по истечении срока его жизни. См. ветки базы данных ветки базы данных, чтобы узнать об ограничениях и о том, что клонируется.

  • 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)

Управление схемой, синхронизация, push/pull и запросы 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] — выводит список самых медленных SQL-запросов через pg_stat_statements.
  • 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 (ВЫБРАТЬ, ВСТАВИТЬ, ОБНОВИТЬ, УДАЛИТЬ или ВСЕ)
  • 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] — Удалить функцию SQL Postgres.
  • 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] — Сбрасывает шаблон к значениям по умолчанию.

Edge-функции 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 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> — генерирует сценарии автозаполнения для вашей оболочки.

Интерактивный интерфейс в терминале#

Aurabase включает интерфейс текстового режима (aura ui), созданный на базе Ratatui. Он позволяет вам перемещаться по базам данных, выполнять 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.

Чтобы пойти дальше#