Metadata-Version: 2.5
Name: ctx-harness
Version: 0.39.0
Summary: straitjacket: context and evidence sidecar for coding agents. Keep your harness; add bounded output, retrieval, and edit verification.
Project-URL: Homepage, https://github.com/vamsiramakrishnan/straitjacket
Project-URL: Repository, https://github.com/vamsiramakrishnan/straitjacket
Project-URL: Changelog, https://github.com/vamsiramakrishnan/straitjacket/blob/main/CHANGELOG.md
Author: straitjacket contributors
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Keywords: agent,antigravity,context,harness,mcp
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.11
Requires-Dist: pathspec>=0.12
Provides-Extra: code
Requires-Dist: ast-grep-py>=0.45; extra == 'code'
Requires-Dist: jedi>=0.20; extra == 'code'
Requires-Dist: tree-sitter-go>=0.25; extra == 'code'
Requires-Dist: tree-sitter-javascript>=0.25; extra == 'code'
Requires-Dist: tree-sitter-python>=0.25; extra == 'code'
Requires-Dist: tree-sitter-rust>=0.24; extra == 'code'
Requires-Dist: tree-sitter-typescript>=0.23; extra == 'code'
Requires-Dist: tree-sitter>=0.25; extra == 'code'
Provides-Extra: dev
Requires-Dist: jsonschema>=4; extra == 'dev'
Requires-Dist: pytest>=8; extra == 'dev'
Provides-Extra: fast
Requires-Dist: orjson>=3; extra == 'fast'
Provides-Extra: image
Requires-Dist: pillow>=10; extra == 'image'
Provides-Extra: map
Requires-Dist: grimp>=3.15; extra == 'map'
Requires-Dist: networkx>=3.4; extra == 'map'
Provides-Extra: scip
Requires-Dist: protobuf>=5.26; extra == 'scip'
Provides-Extra: sem
Requires-Dist: semgrep>=1.60; extra == 'sem'
Description-Content-Type: text/markdown

# straitjacket

**Context and evidence sidecar for coding agents.**

Keep your coding harness. Straitjacket runs alongside it, captures command
output in a local artifact store, and returns a bounded, deterministic digest.
The agent can search the complete output or
retrieve a cited region without loading the whole log into its conversation.

**Keep using your coding agent.** Claude Code, Codex, and Antigravity remain
supported. Straitjacket adds capture, bounded retrieval, and an optional verified
edit workflow to the agent you choose; you keep its interface, models, login,
and permissions. Any terminal-capable agent can use the `ctx` CLI.

The coding harness owns the model and tool loop. Straitjacket supplies capture,
retrieval, and optional edit verification through CLI commands, MCP tools, and
supported hooks. “Sidecar” describes this supporting role; no separate daemon
or container is required. The package name remains `ctx-harness`.

<p>
  <a href="https://code.claude.com/"><img src="assets/agents/claude.svg" width="36" height="36" alt="Claude Code" title="Claude Code"></a>
  <a href="https://developers.openai.com/codex/"><img src="assets/agents/codex.svg" width="36" height="36" alt="Codex" title="Codex"></a>
  <a href="https://antigravity.google/"><img src="assets/agents/antigravity.png" width="36" height="36" alt="Antigravity" title="Antigravity"></a>
  <a href="https://github.com/NousResearch/hermes-agent"><img src="assets/agents/hermes.svg" width="36" height="36" alt="Hermes" title="Hermes"></a>
  <a href="https://github.com/can1357/oh-my-pi"><img src="assets/agents/omp.svg" width="36" height="36" alt="Oh My Pi" title="Oh My Pi"></a>
  <a href="https://opencode.ai/"><img src="assets/agents/opencode.svg" width="36" height="36" alt="OpenCode" title="OpenCode"></a>
  <a href="https://github.com/deepseek-ai/deepseek-harness"><img src="assets/agents/dsh.svg" width="36" height="36" alt="DeepSeek Harness" title="DeepSeek Harness"></a>
</p>

v0.39.0 · Python 3.11+ · package `ctx-harness` · command `ctx` · pre-1.0 · Apache-2.0

[Start here](docs/GETTING-STARTED.md) · [Choose a workflow](docs/USE-CASES.md) ·
[CLI reference](docs/CLI.md) · [Documentation site](https://vamsiramakrishnan.github.io/straitjacket/)

## Capture your first result

From a repository with a test suite:

```bash
python -m pip install --upgrade ctx-harness
ctx run -- pytest -q
```

No host integration is required for this command. A failed test command remains
a failed command. straitjacket changes how its evidence reaches the agent.

A large pytest result identifies failing tests and provides a `run:` address.
Use the address and coordinates printed by your run:

```bash
ctx get run:<id>#stdout --lines 120:180
ctx search run:<id>#stdout "AssertionError"
```

`<id>` is a placeholder, not a checked-in sample you can retrieve. The stored
artifact contains the complete captured stream. Retrieval is bounded too: a
large request returns a smaller region with a continuation.

When that loop is useful, connect the host you already use:

```bash
ctx setup
ctx doctor
```

Setup preserves unrelated settings and reports the changes it makes.
[Installation, host setup, and removal](docs/GETTING-STARTED.md).

## Choose the work you want to improve

| Job | Use | What you can inspect afterward |
|---|---|---|
| Diagnose a long test run, build, or log | `ctx run -- <command>` | Outcome, typed digest, complete stdout/stderr |
| Find the relevant symbol before reading files | `ctx map`, `ctx def`, `ctx refs` | Bounded structural views and source coordinates |
| Compare a failure with the next attempt | `ctx diff run:A run:B` | Changes in outcomes and evidence |
| Run a known sequence of checks | `ctx seq`, `ctx q` | Locally composed results with evidence addresses |
| Edit the source you actually observed | `ctx edit replace`, `ctx edit verify` | Sealed plan, apply receipt, checks tied to file hashes |
| Continue a task across workers | `ctx orchestrate`, `ctx task show` | Persisted task state, attempts, recovery, and budget records |
| Tell another harness something, between turns | `ctx relay watch`, `ctx relay signal` | Queued signals, delivery receipts, and what each harness has seen |
| Analyze selected evidence with a model | `ctx semantic prepare/run/resume` | Bounded partitions, citation validation, explicit budgets, and saved partial findings |
| Investigate and verify a repair | `ctx task prepare/run/resume` | One durable budget from evidence gathering through verified patch; [workflow and SDK](docs/TASK-EXECUTION.md) |

Start with capture and retrieval. Add editing or orchestration when the task
needs their contracts. See the [verified edit loop](docs/EDIT-LOOP.md) for
snapshot-based replacements, typed recovery, and prewalk handoffs.

[Semantic analysis](docs/SEMANTIC.md) is an explicit depth-one map over frozen
evidence through a caller-configured model driver. Its findings are labeled
inferences; complete processing does not establish complete evidence selection
or a correct patch. Deterministic capture and retrieval never invoke it implicitly.

## Why preserve the output outside the prompt?

A build log can outlive the decision it supported. Once pasted into the
conversation, it can occupy context on every later turn. Truncation removes
bytes the agent may need later; a free-form summary cannot provide the exact
original evidence.

straitjacket retains those bytes and gives the prompt a smaller view. Typed
profiles keep test identities, diagnostic locations, unusual log events, or
JSON structure according to the output family. They declare omissions and
provide retrieval addresses. There is no model call in the digest path.

Stored `run:`, `blob:`, and `snapshot:` handles identify immutable content while
retained. Live `repo:` addresses can carry a content anchor: reads verify the
span, relocate unchanged content, or refuse stale evidence.

[Follow one command through the system](docs/HOW-IT-WORKS.md).

## Decide whether to use it

| Your workload | Starting choice |
|---|---|
| Large outputs early in a long investigation | Capture them and retrieve only the evidence needed next |
| Repeated repository navigation | Use structural queries; watch retrieval count as well as token volume |
| Small output in a short task | Keep native execution; wrapping can add overhead |
| Need predictable local behavior without another model call | Use the CLI directly |
| Need transparent interception | Check the host matrix below before adopting |

Measure task completion, total usage, elapsed time, and retrieval calls together.
Compression alone does not establish a better coding outcome.

## Evidence, including the losses

The repository publishes fixtures, harnesses, raw records, and negative results
in [`evals/`](evals/). Two mechanism tests establish the core behavior:

- A deterministic 20,001-line log contains one quiet target at line 14,238 and
  two loud `ERROR` controls. Raw delivery uses 302,628 `o200k_base` tokens.
  straitjacket emits 531, retains the quiet target, and emits an address for the
  omitted region. This fixture checks address emission, not a retrieval round
  trip. See the
  [field-needle receipt](evals/field-needle-2026-07-20.md).
- Across 1,920 repository-span resolutions after edits, anchored addresses
  relocated 1,452 times, verified in place twice, refused 466 times, and returned
  the wrong content zero times. See the
  [anchor-drift receipt](evals/anchor-drift-2026-08-20.md).
- The task-ledger replay exercises persisted orchestration state across resume,
  typed recovery, and budget reconciliation. See the
  [task-ledger receipt](evals/task-ledger-replay-2026-09-02.md).

Those results test delivery and addressing. They do not prove that every agent
task becomes cheaper or faster.

The live agent referee records the counterexample. On three small canary tasks,
with one repeat per task, both native and contained arms solved 3/3, but the
contained arm used more input tokens, cost more, and took longer. In one
navigation-heavy dogfood run with a 40-turn cap, the native arm reproduced
eight failing test nodes and the wrapped arm reproduced five. That comparison
tests the full wrapper bundle, not containment alone, and its model field is
unrecorded. The wrapped arm made 210 retrieval calls; without a retrieval
ablation, those calls are a plausible contributor rather than a proven cause.
See the
[agent-harness results](evals/agentbench/RESULTS.md).

That boundary matters. straitjacket is most useful when output is large, early,
repeated, or likely to survive many turns. A short task with small, hot-cached
results may be better left native. The target is matched task success with less
context residency—not the highest compression ratio.

## Host support

| Entry point | Current behavior |
|---|---|
| Direct `ctx` CLI | Capture and retrieval without a host plugin |
| Claude Code | Command rewriting and oversized-result substitution on supported hooks |
| Codex | Implemented and contract-tested gates; live CLI receipt pending |
| Antigravity | Deny recognized floods and supply a bounded replacement command; no output substitution |
| Hermes / Open Hermes | Native argument rewriting and text-output replacement; active-profile plugin + MCP |
| Oh My Pi (`omp`) | Native argument rewriting and text-output replacement; project plugin + MCP |
| OpenCode | Native argument rewriting and text-output replacement; project plugin + MCP |
| DeepSeek Harness (`dsh`) | Native gating and text-output replacement; sealed arguments require an explicit retry |

`ctx setup` merges JSON where safe and refreshes ctx-managed blocks. For
user-owned Codex TOML it prints a reviewed snippet rather than replacing the
file. See [host capabilities](docs/HOST-CAPABILITIES.md) for exact coverage.

[Set up Hermes, OMP, OpenCode, or DSH](docs/AGENT-INTEGRATIONS.md). These adapters
have executable contract tests; live model-session receipts remain pending.
They require a build containing this change.

All seven agents can use [ACP orchestration](docs/ACP.md) with a configured
endpoint and model: `ctx setup --host opencode --acp --acp-model provider/model-id`.
ACP workers receive bounded retrieval and verified edit tools through MCP.
Native hook coverage still depends on the agent's API; ACP does not expand it.

## Boundaries

straitjacket is not:

- a process sandbox—commands retain the invoking user's authority;
- agent memory—it contains current tool evidence rather than choosing which old
  memories to recall;
- a free-form summarizer—digests are deterministic, typed, and addressable;
- a reason to wrap every command—the native path is often right for small work.

The local store contains captured command output as plaintext. Thirty days is
the default GC eligibility horizon; artifacts remain until `ctx gc` runs.
`ctx gc --retention-days N` can override the horizon, while pins and active
checkpoint leases survive collection. Treat the store with the same care as
the source and logs it captures. At-rest encryption is not implemented today.

The project is pre-1.0. Command and profile contracts may still change between
minor releases.

## Read next

| Next step | Guide |
|---|---|
| Install, configure, or remove a host integration | [Getting started](docs/GETTING-STARTED.md) |
| Apply and verify an observed edit | [Edit loop](docs/EDIT-LOOP.md) |
| Compare native, anchored, and prewalk strategies | [Paired evaluations](evals/EDIT-MATRIX.md) |
| Tune budgets and retention | [Configuration](docs/CONFIGURATION.md) |
| Resolve an error | [Troubleshooting](docs/TROUBLESHOOTING.md) |
| Understand modules or contribute | [Architecture](docs/ARCHITECTURE.md), [Contributing](CONTRIBUTING.md) |
| Browse the full reference | [Documentation map](docs/README.md), [Changelog](CHANGELOG.md) |

## Development

```bash
git clone https://github.com/vamsiramakrishnan/straitjacket.git
cd straitjacket
python -m pip install -e '.[dev]'
pytest
```

New mechanisms need deterministic output, explicit degradation, and a named
evaluation gate. Follow [CONTRIBUTING.md](CONTRIBUTING.md).
