docs(readme, cli, system requirements): add full CLI reference, delete stale development README#1524
Merged
spomichter merged 26 commits intodevfrom Mar 11, 2026
Merged
docs(readme, cli, system requirements): add full CLI reference, delete stale development README#1524spomichter merged 26 commits intodevfrom
spomichter merged 26 commits intodevfrom
Conversation
- New docs/usage/cli.md: all commands, global options, standalone tools, MCP integration, config precedence, file locations - Delete docs/development/README.md: duplicated main README content - Delete docs/development/dimos_run.md: superseded by cli.md
spomichter
changed the title
- README: compact hardware table, link to full details - docs/requirements.md: tested configs, all dependency extras, core vs docker tier, platform compatibility notes - Subsumes PR #1402 content with expanded dependency coverage
…iers - Alpha Pre-Release → Pre-Release Beta - Arms (Xarm, Piper): experimental → beta - Drones (MAVLink, DJI): experimental → alpha - Delete System Requirements section (moved to docs/requirements.md) - Delete ROS interop section (transports link in Library API) - Add CLI & MCP overview with common commands - Add blueprint composition examples with dimos list - Quote all pip install extras for zsh compatibility - Fix todo.md links → manipulation docs for arms
README.md
Outdated
| dimos log -f # Follow logs | ||
| dimos agent-send "explore the room" # Send agent a command | ||
| dimos mcp list-tools # List available MCP skills | ||
| dimos mcp call move --arg x=0.5 # Call a skill directly |
Contributor
There was a problem hiding this comment.
I don't think this works. I've removed it from Unitree Go2 because it didn't work right (it used direct velocities, not positions). I've replaced it with relative_move.
Suggested change
| dimos mcp call move --arg x=0.5 # Call a skill directly | |
| dimos mcp call relative_move --arg forward=0.5 # Call a skill directly |
Looks like there's a move on UnitreeG1SkillContainer. I should replace that.
There's also a move on the drone, but it takes a Vector3 param, and I don't think we can construct that from JSON arguments from the agent.
docs/requirements.md
Outdated
Comment on lines
+32
to
+35
| pip install dimos[base,unitree] # Full stack + Unitree | ||
| pip install dimos[base,unitree,sim] # + MuJoCo simulation | ||
| pip install dimos[base,unitree,drone] # + Drone support | ||
| pip install dimos[base,unitree,manipulation] # + Arm control |
Contributor
There was a problem hiding this comment.
Suggested change
| pip install dimos[base,unitree] # Full stack + Unitree | |
| pip install dimos[base,unitree,sim] # + MuJoCo simulation | |
| pip install dimos[base,unitree,drone] # + Drone support | |
| pip install dimos[base,unitree,manipulation] # + Arm control | |
| pip install 'dimos[base,unitree]' # Full stack + Unitree | |
| pip install 'dimos[base,unitree,sim]' # + MuJoCo simulation | |
| pip install 'dimos[base,unitree,drone]' # + Drone support | |
| pip install 'dimos[base,unitree,manipulation]' # + Arm control |
… requirements link
Contributor
Greptile SummaryThis PR is a documentation overhaul that adds a comprehensive CLI reference ( Key changes:
Confidence Score: 4/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant User
participant CLI as dimos CLI
participant Registry as Run Registry
participant Daemon as DimOS Daemon
participant MCP as MCP Server
participant Agent as LLM Agent
User->>CLI: dimos run blueprint --daemon
CLI->>Daemon: fork + health check
Daemon->>Registry: write run-id, PID, args, ports
CLI-->>User: run ID, PID, log path, MCP endpoint
User->>CLI: dimos status
CLI->>Registry: read run entry
CLI->>Daemon: verify PID alive
CLI-->>User: uptime, blueprint, MCP port
User->>CLI: dimos agent-send text
CLI->>Daemon: publish to /human_input via LCM
Daemon->>Agent: deliver text
Agent-->>Daemon: skill calls + response
User->>CLI: dimos mcp list-tools
CLI->>MCP: GET /mcp tool listing
MCP-->>CLI: JSON tool schemas
CLI-->>User: available skills
User->>CLI: dimos mcp call relative_move --arg forward=0.5
CLI->>MCP: POST /mcp tool call
MCP->>Daemon: execute skill RPC
Daemon-->>MCP: result
MCP-->>CLI: tool result
CLI-->>User: output
User->>CLI: dimos stop
CLI->>Daemon: SIGTERM then SIGKILL
CLI->>Registry: remove run entry
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Comment on lines
+40
to
+41
| - Docstrings become the tool description the LLM sees. Write them clearly so the agent has sufficent context. | ||
| - The function must return a string or image which with be used by the agent to decide what to do next. |
Contributor
There was a problem hiding this comment.
Two copy errors in the Skills rules
Line 40 has a typo ("sufficent" → "sufficient") and line 41 has a word transposition ("which with be used" → "which will be used").
Suggested change
| - Docstrings become the tool description the LLM sees. Write them clearly so the agent has sufficent context. | |
| - The function must return a string or image which with be used by the agent to decide what to do next. | |
| - Docstrings become the tool description the LLM sees. Write them clearly so the agent has sufficient context. | |
| - The function must return a string or image which will be used by the agent to decide what to do next. |
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
2 participants
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
Closes DIM-XXX
Solution
Breaking Changes
How to Test
Contributor License Agreement