Skip to content

docs: Recommend installing Eclipse Enclave in the README's first steps - #17

Merged
planger merged 2 commits into
mainfrom
homeshell-readme-enclave
Nov 19, 2026
Merged

planger merged 2 commits into
mainfrom
homeshell-readme-enclave

Conversation

@planger

@planger planger commented Nov 19, 2026

Copy link
Copy Markdown
Contributor

What and why

The README barely mentions Eclipse Enclave. HomeShell works without it, but makes more sense with
it, so First use gets an optional step 0 that recommends installing Enclave and links to its
getting-started guide.

Changelog

none

Checklist

  • Tests added: unit and e2e, or a regression test for a bug fix (see AGENTS.md) — docs only
  • Docs updated per the trigger table in AGENTS.md

HomeShell works without Enclave, but it makes more sense with it: agents
run contained, at full autonomy. Step 0 of First use says so and links
to Enclave's getting-started guide.

@EclipseSourceAI EclipseSourceAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note

Autonomous AI review. May contain mistakes.

Useful comment? React 👍. Disagree? React 👎 to reject it for follow-up reviews. A reply explaining why helps too.

This agent never approves PRs. A maintainer must sign off.

Only a maintainer can re-request a review from this agent.

Powered by Eclipse Enclave via review-guard-mcp

Docs-only PR: adds an optional step 0 to the README's First use list that recommends installing Eclipse Enclave, says briefly what it gives you (one container per agent, full autonomy, filtered network), and links Enclave's getting-started guide.

I checked the claims against the code. Enclave availability is checked live (exec.LookPath on each Available call), so installing it after the daemon is already running works without a restart. The provider selector in the new-session form matches "pick Eclipse Enclave as the provider". Line lengths and the reference-style link follow the README's existing conventions. none in the changelog block is fine for a README-only change. There's no UI change, so I skipped visual testing.

Two inline points for a maintainer:

  • The Install section already mentions the enclave CLI, so this puts the recommendation in a second place. It also means a software install now sits under First use, after Run.
  • "Sessions you start with enclave in a terminal show up too" claims more than the code does. Only sessions in a project's folder get adopted.

Comment thread README.md Resolved
Comment thread README.md Resolved
Clarify instructions for starting a session with Eclipse Enclave.
@planger
planger requested a review from fismif November 19, 2026 08:49

@fismif fismif left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@planger
planger merged commit c6255de into main Nov 19, 2026
6 checks passed
@planger
planger deleted the homeshell-readme-enclave branch November 19, 2026 09:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants