agentuity avatar

agentuity-cli-cloud-db-get

Show details about a specific database. Requires authentication. Use for Agentuity cloud platform op

作者 agentuity|オープンソース

Cloud Db Get

Show details about a specific database

Prerequisites

  • Authenticated with agentuity auth login
  • Organization context required (--org-id or default org)

Usage

agentuity cloud db get <name> [options]

Arguments

ArgumentTypeRequiredDescription
<name>stringYes-

Options

OptionTypeRequiredDefaultDescription
--showCredentialsbooleanYes-Show credentials in plain text (default: masked in terminal, unmasked in JSON)
--showTablesbooleanYes-Fetch table schemas from the database
--sqlbooleanYes-Output table schemas as SQL CREATE statements

Examples

Get database details:

bunx @agentuity/cli cloud db get my-database

Show database information:

bunx @agentuity/cli cloud db show my-database

Get database with credentials:

bunx @agentuity/cli cloud db get my-database --show-credentials

Get table schemas from the database:

bunx @agentuity/cli cloud db get my-database --show-tables

Get table schemas as SQL CREATE statements:

bunx @agentuity/cli cloud db get my-database --show-tables --sql

Get table schemas as JSON:

bunx @agentuity/cli cloud db get my-database --show-tables --json