Skip to content

docs: add missing CLI commands and service install instructions - #389

Open
brocasm wants to merge 1 commit into
co-l:developfrom
brocasm:docs/fix-readme-cli-docs
Open

brocasm wants to merge 1 commit into
co-l:developfrom
brocasm:docs/fix-readme-cli-docs

Conversation

@brocasm

@brocasm brocasm commented Sep 28, 2026

Copy link
Copy Markdown

Summary

Updated the README documentation to include previously undocumented CLI commands and a new Quick Start section for persistent operations.

Changes made:

  • Added documentation for 5 missing CLI commands: openfox service, openfox pwa, openfox mcp, openfox install, and openfox update — updating the "CLI Commands" section from 6 to 11 documented commands.

  • Added a Persistent launcher note to Quick Start explaining openfox install (project-scoped launcher).

  • Added a Service mode note to Quick Start explaining openfox service commands (systemd service for auto-start on boot).

Why: The README was incomplete for users setting up OpenFox locally — they didn't know about service mode (for server deployments), PWA management, MCP client config, or how to create a persistent launcher from a project folder.

AI-Enhanced Development

AI Models: Bonsai-2 agent explorer
Cache Impact
No — This PR only edits documentation (README.md). No system prompts, tools, skills, or other cached context is affected.

- Added openfox service, pwa, mcp, install, and update commands
- Added persistent launcher (install) and service mode (service) notes to Quick Start
@github-actions github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation labels Sep 28, 2026
@JamesDAdams JamesDAdams self-assigned this Sep 29, 2026
@JamesDAdams
JamesDAdams requested a review from co-l September 29, 2026 13:14
@JamesDAdams

Copy link
Copy Markdown
Collaborator

Ok for me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants