docs: expand README to cover all CLI commands and server mode#35
Draft
docs: expand README to cover all CLI commands and server mode#35
Conversation
…egration, and all CLI commands Co-authored-by: Benbentwo <14911525+Benbentwo@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README to include server mode features
docs: expand README to cover all CLI commands and server mode
Feb 21, 2026
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.
The README only documented a subset of commands and gave a shallow overview of server mode, leaving MCP integration, dashboard, and most flags undiscovered.
Commands section
Added per-command subsections with flag tables and usage examples for every top-level command that was missing or undocumented:
build(--target,--state),clean(--all),package(--output,--state),run,upgrade(--check,--force),version. Also corrected theconosletypo in the Usage block and added the missing commands to the listing.Server mode
Replaced the bullet-list overview with:
~/.ue5/state.json,~/.ue5/logs/<hash>/)start,stop,status,run,kill,rebuild,logs,build-info,agentsMCP integration
New section documenting the MCP SSE server (port 9515), all exposed tools (
rebuild,register_agent,unregister_agent,get_build_info), readable resources (ue5://build/current,ue5://agents,ue5://instances), and environment variables (UE5_MCP_PORT,UE5_DASHBOARD_PORT).🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.