diff --git a/docs/06-concepts/cli/_generated/cloud.md b/docs/06-concepts/cli/_generated/cloud.md index 8b137891..e69de29b 100644 --- a/docs/06-concepts/cli/_generated/cloud.md +++ b/docs/06-concepts/cli/_generated/cloud.md @@ -1 +0,0 @@ - diff --git a/docs/06-concepts/cli/_generated/database.md b/docs/06-concepts/cli/_generated/database.md new file mode 100644 index 00000000..c785c92a --- /dev/null +++ b/docs/06-concepts/cli/_generated/database.md @@ -0,0 +1,30 @@ +## Usage + +```console +Manage the embedded PostgreSQL database used by a Serverpod project. + +Usage: serverpod database [arguments] +-h, --help Print this usage information. + +Available subcommands: + start Start the configured embedded PostgreSQL database over TCP. + +Run "serverpod help" to see global options. +``` + +### Sub commands + +#### `start` + +```console +Start the configured embedded PostgreSQL database over TCP. + +Usage: serverpod database start [arguments] +-h, --help Print this usage information. +-s, --server-dir= Server project directory. Defaults to auto-detection. +-m, --mode Serverpod run mode whose database config should be used. + (defaults to "development") +-p, --port= TCP port override. Defaults to the configured database port. + +Run "serverpod help" to see global options. +``` diff --git a/docs/06-concepts/cli/_generated/global_options.md b/docs/06-concepts/cli/_generated/global_options.md index ffc6a6fd..57b8a5f1 100644 --- a/docs/06-concepts/cli/_generated/global_options.md +++ b/docs/06-concepts/cli/_generated/global_options.md @@ -21,6 +21,7 @@ Available commands: create Creates a new Serverpod project, specify project name (must be lowercase with no special characters). create-migration Creates a migration from the last migration to the current state of the database. create-repair-migration Repairs the database by comparing the target state to what is in the live database instead of comparing to the latest migration. + database Manage the embedded PostgreSQL database used by a Serverpod project. generate Generate code from yaml files for server and clients. language-server Launches a serverpod language server communicating with JSON-RPC-2 intended to be used with a client integrated in an IDE. mcp-server Start an MCP bridge to the `serverpod start` runner of one server project. diff --git a/docs/06-concepts/cli/commands/database/_category_.json b/docs/06-concepts/cli/commands/database/_category_.json new file mode 100644 index 00000000..ad620deb --- /dev/null +++ b/docs/06-concepts/cli/commands/database/_category_.json @@ -0,0 +1 @@ +{"label": "database"} \ No newline at end of file diff --git a/docs/06-concepts/cli/commands/database/_database.md b/docs/06-concepts/cli/commands/database/_database.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/06-concepts/cli/commands/database/database.mdx b/docs/06-concepts/cli/commands/database/database.mdx new file mode 100644 index 00000000..5071f0a9 --- /dev/null +++ b/docs/06-concepts/cli/commands/database/database.mdx @@ -0,0 +1,9 @@ +--- +title: "" +--- +import MaintainedCommandIntro from './_database.md'; +import Database from '../../_generated/database.md'; + + + +