docs: Add framework CLI command reference#649
Conversation
|
|
||
| # Introduction to the Serverpod CLI | ||
|
|
||
| The Serverpod CLI (`serverpod`) creates projects, generates server and client code, and manages your database migrations from the command line. This reference covers every command, option, and flag. |
There was a problem hiding this comment.
Really clean reference, the generator + composer setup is great.
One coverage gap: serverpod start isn't here. It's experimental and doesn't show in serverpod --help (even with --experimental-features), so the generator skipping it makes sense. But serverpod start is the headline command in the get-started docs (Quickstart, How it works), so readers will come looking for it here. Since this line says "every command," could we either add a start page flagged experimental, or add a pointer to the existing serverpod start page (00-start-command.md)?
There was a problem hiding this comment.
Added a manual start command page under commands/start
developerjamiu
left a comment
There was a problem hiding this comment.
Good changes 🙌. Some comments
|
|
||
| When it boots the server, `serverpod start` applies any pending migrations. While it runs, you create and apply new migrations from the terminal UI (see [Terminal UI shortcuts](#terminal-ui-shortcuts)). | ||
|
|
||
| ## Usage |
There was a problem hiding this comment.
This page is now basically identical to 00-start-command.md at the top of the Concepts section (same usage tables, terminal UI shortcuts, server args). Now that the CLI reference has a serverpod start page, I think 00-start-command.md could become more concept-like (the dev loop, what start does) and link over here for the usage, instead of duplicating it. That's a follow-up on 00-start-command.md rather than a change to this PR, just flagging it here so it's tracked.
Problem
The framework
serverpodCLI had no command reference in the docs. The Tools section covered insights, lsp, run-scripts, and shell-completion, but there was no per-command reference forserverpod create,generate,create-migration, and the rest. The Serverpod Cloud CLI already has a full reference; the framework CLI did not.Solution
Adds a CLI command reference under the Reference section at
docs/06-concepts/23-cli/, mirroring the structure of the Serverpod Cloud CLI reference:_<command>.md) with an auto-generated usage block (_generated/<command>.md) through a.mdxcomposer, the same pattern the Cloud reference uses.The usage blocks are generated from
serverpod3.5.0-beta.10 withutil/generate_cli_reference.sh, an interim in-repo generator. A CLI-driven sync bot in the monorepo (like the Cloudserverpod-cloud-docs-syncbot) is being discussed separately to keep these in sync automatically.Closes #609.