docs: Add framework CLI command reference#649
Open
Zfinix wants to merge 4 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.