docs: rewrite README.md to reflect current codebase state#5
Merged
mjenkinsx9 merged 2 commits intomainfrom Mar 26, 2026
Merged
Conversation
Agent-Logs-Url: https://github.com/Mike-Jenkins-Org/PortableCoder/sessions/9ca10a35-d512-4abd-bb3a-2262d7e54abf Co-authored-by: mjenkinsx9 <238907794+mjenkinsx9@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README.md with installation and usage instructions
docs: rewrite README.md to reflect current codebase state
Mar 26, 2026
mjenkinsx9
approved these changes
Mar 26, 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.
README was outdated — missing Linux/macOS instructions, undocumented commands/flags, an inaccurate file layout, and no coverage of environment variables.
Changes
Accuracy
scripts/adapters/catalog.json,state/vm/,state/tmp/,runtime/linux/vm-manifest.json,runtime/linux/cloud-init/,profiles/defaults/,profiles/local/)linux-portablemode on non-Windows runs host-native with isolated portable auth (no VM)Coverage gaps filled
--sync-back,--no-sync-back,--force(bootstrap),--mode(run), and--resumeusage examplestate/auth/claude/host/) and API key modeANTHROPIC_*andPCODER_*varsStructure
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.