mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-11-22 13:29:19 +08:00
fix: Add info about apply to README.md (#1592)
## Description Added into to README about apply command and why it's needed. Closes # ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [x] Documentation update - [ ] Performance improvement - [ ] Code refactoring (no functional changes) ## Changes Made - Added into to README about apply command ## Testing <!-- Check what you actually ran, then paste the real command output below. --> - [ ] Unit tests pass (`pytest`) - [ ] Linting passes (`ruff check .`) - [ ] Type checking passes (`mypy headroom`) - [ ] New tests added for new functionality - [x] Manual testing performed ### Test Output ```text git diff --check: passed Documentation-only diff: 6 lines ``` ## Real Behavior Proof - Environment: current README and persistent-install documentation on the latest PR head. - Exact command / steps: compared the revised quickstart note with current wrap/deploy/install behavior and ran `git diff --check`. - Observed result: the note now distinguishes session-scoped wrap, turnkey persistent deploy, and lower-level install apply without claiming wrap writes durable config. - Not tested: rendered documentation site or a live persistent installation. ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review ## Checklist - [x] I have made corresponding changes to the documentation ## Additional Notes Related to discussion on linkedin. <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/headroomlabs-ai/headroom/pull/1592" target="_blank"><picture><source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-devin-review-dark.svg?v=4"><img src="https://static.devin.ai/assets/gh-devin-review-light.svg?v=4" alt="Devin Review"></picture></a> <!-- devin-review-badge-end --> Co-authored-by: JD Davis <jd@jds-macbook-air.tail2a279.ts.net> Co-authored-by: Jerrett Davis <mxjerrett@gmail.com>
This commit is contained in:
co-authored by
JD Davis
Jerrett Davis
parent
effa5a5886
commit
4d34680c34
@@ -131,6 +131,12 @@ Headroom. For Claude Code, Serena is registered for the wrapped project only
|
||||
`--code-memory-scope user` to make it available in every project, or
|
||||
`--code-memory none` to skip it. `headroom unwrap` removes either registration.
|
||||
|
||||
`headroom wrap ...` is session-scoped: its proxy exits with the wrapped agent.
|
||||
For a proxy that survives reboots, use the turnkey `headroom deploy` command.
|
||||
Use `headroom install apply` when you need to choose a specific persistent
|
||||
service, scheduled task, Docker runtime, scope, or provider target; see the
|
||||
[persistent installs guide](https://docs.headroomlabs.ai/docs/persistent-installs).
|
||||
|
||||
The `headroom` CLI ships only in the PyPI package. The npm `headroom-ai` package
|
||||
is the TypeScript SDK — a library you import
|
||||
(`import { compress } from 'headroom-ai'`) — and provides no `headroom` command.
|
||||
|
||||
Reference in New Issue
Block a user