Skip to content

docs: mention Docker CLI for Colima installs#6078

Open
WilliamK112 wants to merge 1 commit into
NVIDIA:mainfrom
WilliamK112:codex/nemoclaw-colima-docker-cli-docs
Open

docs: mention Docker CLI for Colima installs#6078
WilliamK112 wants to merge 1 commit into
NVIDIA:mainfrom
WilliamK112:codex/nemoclaw-colima-docker-cli-docs

Conversation

@WilliamK112

@WilliamK112 WilliamK112 commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

  • clarify that Homebrew Colima users need the Docker CLI package as well as Colima
  • add first-run macOS Colima commands in prerequisites and troubleshooting
  • update ci/platform-matrix.json and the generated platform-support tables together

Fixes #6028

Validation

  • git diff --check
  • PYTHONUTF8=1 python scripts/generate-platform-docs.py --check
  • rg -n "brew install colima docker|brew install docker|Homebrew Colima|Docker CLI separately|colima start --cpu 4 --memory 8" ci docs

Notes

  • On Windows, npx vitest run --project integration test/generate-platform-docs.test.ts runs with a temporary python3.exe shim and reaches the test body; 15/18 tests pass, while 3 existing assertions assume Linux stdout newlines or POSIX temp paths. This PR only changes docs/matrix content.

Summary by CodeRabbit

  • Documentation
    • Expanded macOS setup guidance with clearer Colima installation and startup steps.
    • Added instructions to install the Docker CLI separately and verify the setup with docker info.
    • Updated platform support and troubleshooting docs with more detailed Apple Silicon and Colima-specific guidance.

Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com>
@copy-pr-bot

copy-pr-bot Bot commented Jul 1, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 1615db61-f89e-4759-b407-c4c42240bd66

📥 Commits

Reviewing files that changed from the base of the PR and between e4b9111 and 5490aaf.

📒 Files selected for processing (4)
  • ci/platform-matrix.json
  • docs/get-started/prerequisites.mdx
  • docs/reference/platform-support.mdx
  • docs/reference/troubleshooting.mdx

📝 Walkthrough

Walkthrough

Documentation updates across CI platform matrix config and three MDX docs files add guidance that macOS Homebrew Colima users must also install the Docker CLI separately (brew install colima docker) so docker info can reach the Colima daemon. Troubleshooting steps are also expanded.

Changes

Colima Docker CLI Documentation

Layer / File(s) Summary
Prerequisites and platform matrix guidance
docs/get-started/prerequisites.mdx, ci/platform-matrix.json, docs/reference/platform-support.mdx
Adds a shell snippet installing Colima and Docker CLI, starting Colima with CPU/memory settings, and verifying with docker info; updates macOS (Apple Silicon) notes in CI config and rendered platform tables to mention the Docker CLI requirement.
Troubleshooting Colima/Docker CLI remediation
docs/reference/troubleshooting.mdx
Adds Colima/Homebrew install steps to the macOS first-run failures section, and adds guidance to install the Docker CLI via Homebrew when colima status succeeds but docker info/which docker fails.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main doc change: adding Docker CLI guidance for Colima installs.
Linked Issues check ✅ Passed The docs now instruct users to install Colima and the Docker CLI, start Colima, and verify with docker info as requested in #6028.
Out of Scope Changes check ✅ Passed The platform matrix and generated support docs updates are in scope because they keep the Colima guidance synchronized across docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@wscurran wscurran added area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance platform: macos Affects macOS, including Apple Silicon labels Jul 1, 2026
@wscurran

wscurran commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

✨ Thanks for the fix. Adding the Docker CLI clarification for Colima installs and updating the platform matrix together keeps docs and generated tables in sync.


Related open issues:

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

Labels

area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance platform: macos Affects macOS, including Apple Silicon

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[macOS][Docs] Colima installation recommendation omits docker CLI — should be brew install colima docker

2 participants