Skip to content

[docs] - README: document the PowerShell coding harness (harness/ + powershell/)#650

Merged
cgfixit merged 1 commit into
mainfrom
claude/cyclaw-optimize-readme-harness
Jul 24, 2026
Merged

[docs] - README: document the PowerShell coding harness (harness/ + powershell/)#650
cgfixit merged 1 commit into
mainfrom
claude/cyclaw-optimize-readme-harness

Conversation

@cgfixit

@cgfixit cgfixit commented Jul 23, 2026

Copy link
Copy Markdown
Owner

Proposed changes

Phase 1 doc-sync deliverable: the README predated the harness merge (#635/#643, 2026-07-22) — the new out-of-band harness/ console package, its powershell/ installer, and the 127.0.0.1:8790 console were absent from What It Does, the TOC, and the Project Structure tree. (The existing "Agentic Harness Scaffold (v1.9)" section covers the older agentic/harness_optimizer scaffold — a different subsystem — so readers had no pointer to the actual console.)

Adds, README-only (+42 lines, no deletions):

  • A concise "PowerShell Coding Harness (v1.9)" section — launch (cyclaw-harness127.0.0.1:8790, loopback-refuses-non-loopback), Windows install one-liner, chat over the OpenAI-compatible /v1 endpoint from config.yaml's models.local_llm.base_url, reuse-not-duplication (ops_runner shim, read-only registry views, ponytail+karpathy system prompt), and I6 isolation — linking to docs/HARNESS_POWERSHELL.md as the authority rather than duplicating it.
  • harness/ and powershell/ entries in the Project Structure tree.
  • Item 10 in What It Does + a TOC entry.

Invariant / Governance Impact: None — documentation only. doc-sync checker: 0 drift after the change.

Types of changes

  • Documentation Update (if none of the other choices apply)

Scope note: Docs only.

Benefits / why

  • The README now reflects the shipped codebase: a newcomer reading only the README learns the harness console exists, how to launch/install it, and where the full doc lives.
  • Numbers are code-sourced, not invented: port 8790 from harness/config.py (DEFAULT_PORT), cyclaw-harness from pyproject.toml [project.scripts], install path from the shipped powershell/Install-CyClaw.ps1.

Risks to monitor

  • Doc drift if the harness port/entry-point changes later — the section cites config.yaml/harness/config.py values, and the doc-sync skill's manual pass covers README prose; keep the section pointed at docs/HARNESS_POWERSHELL.md for details so drift surface stays small.

Further comments

Verified: python3 .claude/skills/doc-sync/doc_sync.py → 0 drift items; TOC anchor matches the heading exactly once; pure-addition diff touches nothing else. Part of the Phase 1 optimize pass (Ollama/LM-Studio compat PRs to follow from the scan in progress).

🤖 Generated with Claude Code

https://claude.ai/code/session_0138hmScu3tFU4v1jzvFUwVT


Generated by Claude Code

…rshell/)

README predated the harness merge (#635/#643 on 2026-07-22): the new
out-of-band console package, its Windows installer, and its 127.0.0.1:8790
console were absent from What It Does, the TOC, and the Project Structure
tree, while the existing "Agentic Harness Scaffold (v1.9)" section describes
the older agentic/harness_optimizer scaffold — a different subsystem.

Add a concise "PowerShell Coding Harness (v1.9)" section (launch, install,
chat path over the OpenAI-compatible /v1 endpoint, reuse-not-duplication,
I6 isolation) linking to docs/HARNESS_POWERSHELL.md as the authority,
plus tree entries for harness/ and powershell/ and item 10 in What It Does.
All numbers sourced from harness/config.py and pyproject.toml; doc-sync
checker reports 0 drift after the change.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0138hmScu3tFU4v1jzvFUwVT
@cgfixit
cgfixit marked this pull request as ready for review July 24, 2026 15:31
@cgfixit
cgfixit merged commit 563e308 into main Jul 24, 2026
36 checks passed
@cgfixit
cgfixit deleted the claude/cyclaw-optimize-readme-harness branch July 24, 2026 15:31
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.

2 participants