coldpass

adamchainz/blacken-docs

GitHub ↗ · How this check works

Per-setup public labels: Linux / Haiku: Works · Linux / Luna: Didn’t work

Static status badge · SVG · read-only JSON. Embed with ![Coldpass status](https://coldpass.dev/badge/adamchainz--blacken-docs.svg).

creative

Works in specific setups

The recorded run passed on 1 setup. Other recorded outcomes appear below.

Answers apply to each recorded setup, revision and operation. Earlier observations remain in Run details.

Tested on Linux
PlatformHaikuLuna
Linuxyesno

Linux / Haiku 5.5: yes · Oct 27, 2026 · 8e7705218838 · claude-code / 2.1.310 (Claude Code)
Recorded operation: blacken-docs --check <guest-path>

Linux / Luna: no · Oct 27, 2026 · 8e7705218838 · codex / codex-cli 0.164.0
Recorded operation: /tmp/blacken-venv/bin/blacken-docs --in-place <guest-path>

Does what it says
2 of 2 claims checked out
  • blacken-docs exits nonzero when a file would be modified: Real input produced the expected result: Requires a rewrite.

    Source: If any file is modified, ``blacken-docs`` exits nonzero.

    Input: <guest-path> with an unformatted python block

    Expected: exit code 1 and a rewrite-needed message

    Command: blacken-docs --check <guest-path>

    Observed: Requires a rewrite.

  • blacken-docs supports reStructuredText files: Real input produced the expected result: Requires a rewrite.

    Source: It supports Markdown, reStructuredText, and LaTex files.

    Input: <guest-path> with an unformatted python code-block

    Expected: rewrite-needed message for the rst file

    Command: blacken-docs --check <guest-path>

    Observed: Requires a rewrite.

MCP
No
Local or hosted
local
Local: runs on your machine
Needs keys or browser
None seen
Maintained
Maintained
actively maintained: last commit 0 days ago; 9 commits and 9 merged PRs in 90 days; 10 open issues, 8 open PRs; 19 of 26 recent threads got a maintainer reply, median first reply 1425.0h; no releases

Last commit Oct 26, 2026

Setup time
1 min 54 s
1 min 54 s to a working result
Issue
none found in confirmed setups
Examples
2 of 2 ran as expected
  • Repository test suite passes (tox.ini testenv command, without coverage wrapper): command completed successfully

    Source: tox.ini [testenv] commands

    Input: tests/

    Expected: all tests pass

    Command: <guest-path> -W error::ResourceWarning -W error::DeprecationWarning -m pytest -p no:cacheprovider tests

    Observed: ============================= test session starts ============================== platform linux -- Python 3.12.3, pytest-9.1.1, pluggy-1.7.0 Using --randomly-seed=1010565475 rootdir: <guest-path> configfile: pyproject.toml plugins: randomly-5.0.0, platformdirs-4.13.6 collected 76 items tests/test_blacken_docs.py ............................................. [ 59%] ............................... [100%] ============================== 76 passed in 0.84s ==============================

  • Check a documentation file without rewriting it: command completed successfully with no output

    Source: README.rst Usage section

    Input: README.rst

    Expected: exit 0, file already formatted

    Command: blacken-docs --check README.rst

Evidence
README behavior checked
Agent interfaces
CLI
CLI

Observed interfaces were exercised by the checker. Documentation alone does not confirm compatibility.

Tested with
Claude Code / Haiku 5.5
  • Linux: Claude Code / Haiku 5.5 · agent 2.1.310 (Claude Code) · Checked operation passed · Oct 27, 2026 on 8e7705218838

Each entry describes its recorded operation and source revision.

Safety
No unexpected network or file activity found in these checks

No problems traced to this repository code in these checks; a short run cannot prove safety.

Reviewed as expected for a test run: attempted writes that failed, so nothing was written.

Full event, path and process lists for each observed setup:

Repair history and test corrections
Current diagnosis: unknown · pending

wrong subcommand or usage-only response: {"argv": ["/tmp/blacken-venv/bin/blacken-docs", "--in-place", "<guest-path>"], "returncode": 2, "stdout": "", "stderr": "usage: blacken-docs [-h] [-l LINE_LENGTH] [--preview] [-S]\n [-t TARGET_VERSIONS] [--check] [-E] [--rst-literal-blocks]\n [--pyi]\n [filenames...]\nblacken-docs: error: unrecognized arguments: --in-place\n", "expected_file": "<guest-path>", "file_checked": false, "file_excerpt": "```python\ndef f(x):\n return(x+1)\n```\n", "needs_credentials": false, "needs_browser": false}

Repair record fix-ff7ec3e448bb2d4c2926 · current status JSON. Original run outcomes remain unchanged.

Failed run: adamchainz/blacken-docs · Oct 27, 2026 · Recorded operation failed.

Run details

Haiku 5.5

Native agent · Checked operation passed

Checked operation blacken-docs --check <guest-path>

Agent-reported scope: Run blacken-docs --check on Markdown and reStructuredText files and get the documented nonzero exit with a rewrite-needed message; run the repo test suite

Run details
run
adamchainz--blacken-docs-claude-haiku-5-5-1793090169379905458
date
Oct 27, 2026
time to working
114.2s
product hosting / execution
Local command in the guest
recorded operation scope
product operation
model
claude-haiku-5-5
agent / version
claude-code / 2.1.310 (Claude Code)
platform
linux
reported cost
$0.014228
Recorded source
https://github.com/adamchainz/blacken-docs
Backend
hyperv
Tool transport
mcp-assigned-vm
Requested source pin (not an observed revision)
{"commit": "8e7705218838da988c103d00ab6ecdd67dea7c37", "url": "https://github.com/adamchainz/blacken-docs"}
Test version
readme-d5b140d3c0f8b95c2dd6fe6fc381a303cacb92679582c22317d8e78b572f0cf2
revision
8e7705218838da988c103d00ab6ecdd67dea7c37
Whose fault: not assigned · resolved

Safety: No problems traced to this repository code in these checks.

No problems traced to this repository code in these checks.

Reviewed as expected for a test run: attempted writes that failed, so nothing was written.

OSV scanned supported lockfiles; unpinned dependencies and unsupported formats are outside this check.

A short run cannot establish that code is safe.

Connections show IP addresses; proxies can hide the final hostname.

Tracing covers dispatched commands and their children, not the whole OS; guest root can interfere with tracing.

Full safety evidence →

Answers recorded for this run
  • blacken-docs exits nonzero when a file would be modified: Real input produced the expected result: Requires a rewrite.

    Source: If any file is modified, ``blacken-docs`` exits nonzero.

    Input: <guest-path> with an unformatted python block

    Expected: exit code 1 and a rewrite-needed message

    Command: blacken-docs --check <guest-path>

    Observed: Requires a rewrite.

  • blacken-docs supports reStructuredText files: Real input produced the expected result: Requires a rewrite.

    Source: It supports Markdown, reStructuredText, and LaTex files.

    Input: <guest-path> with an unformatted python code-block

    Expected: rewrite-needed message for the rst file

    Command: blacken-docs --check <guest-path>

    Observed: Requires a rewrite.

Examples

  • Repository test suite passes (tox.ini testenv command, without coverage wrapper): command completed successfully

    Source: tox.ini [testenv] commands

    Input: tests/

    Expected: all tests pass

    Command: <guest-path> -W error::ResourceWarning -W error::DeprecationWarning -m pytest -p no:cacheprovider tests

    Observed: ============================= test session starts ============================== platform linux -- Python 3.12.3, pytest-9.1.1, pluggy-1.7.0 Using --randomly-seed=1010565475 rootdir: <guest-path> configfile: pyproject.toml plugins: randomly-5.0.0, platformdirs-4.13.6 collected 76 items tests/test_blacken_docs.py ............................................. [ 59%] ............................... [100%] ============================== 76 passed in 0.84s ==============================

  • Check a documentation file without rewriting it: command completed successfully with no output

    Source: README.rst Usage section

    Input: README.rst

    Expected: exit 0, file already formatted

    Command: blacken-docs --check README.rst

Local or hosted: local

What the agent did

Run blacken-docs --check on Markdown and reStructuredText files and get the documented nonzero exit with a rewrite-needed message; run the repo test suite

cd <guest-path> && pwd && ls -la && git status 2>&1 | head -3; id -u; python3 --version; cat README.md 2>/dev/null | head -150
curl -s -m 10 -i $CDP_URL/json/version; echo; echo EXIT=$?
cd <guest-path> && cat README.rst
cd <guest-path> && cat tox.ini pyproject.toml | head -120; ls .coldpass; ls tests src/*
mkdir -p <guest-path> && cd <guest-path> && (python3 -m venv <guest-path> 2>&1 || (sudo -n apt-get -o DPkg::Lock::Timeout=300 install -y python3-venv >/dev/null 2>&1 && python3 -m venv <guest-path>)); ls <guest-path> | head; <guest-path> --version
cd <guest-path> && <guest-path> -m pip install -q --upgrade pip 2>&1 | tail -3; <guest-path> -m pip install <guest-path> 2>&1 | tail -5; ls -la <guest-path>
mkdir -p <guest-path> && cd <guest-path> && printf '# Demo\n\n```python\ndef hello():\n    print( "hello world" )\n```\n' > sample.md && cat sample.md && echo ---- && <guest-path> sample.md; echo EXIT=$?; echo ----; cat sample.md
cd <guest-path> && printf '# Demo\n\n```python\ndef hello():\n    print( "hello world" )\n```\n' > check.md && <guest-path> --check check.md; echo EXIT=$?; cat check.md | head -3; printf 'Title\n=====\n\n.. code-block:: python\n\n    def hello():\n        print( "hello world" )\n' > sample.rst && <guest-path> sample.rst; echo EXIT=$?; cat sample.rst
cd <guest-path> && <guest-path> -m pip install -q "black>=22.1" "coverage[toml]" "pytest>=9" pytest-randomly 2>&1 | tail -3; <guest-path> -m pip list 2>/dev/null | grep -iE "pytest|black|coverage|blacken"
cd <guest-path> && <guest-path> --check README.rst; echo EXIT=$?
cd <guest-path> && PYTHONDONTWRITEBYTECODE=1 PYTHONDEVMODE=1 <guest-path> -W error::ResourceWarning -W error::DeprecationWarning -W error::PendingDeprecationWarning -m pytest -p no:cacheprovider tests 2>&1 | tail -15; echo EXIT=${PIPESTATUS[0]}
mkdir -p <guest-path> && cd <guest-path> && printf '# Demo\n\n```python\ndef hello():\n    print( "hello world" )\n```\n' > check.md && printf 'Title\n=====\n\n.. code-block:: python\n\n    def hello():\n        print( "hello world" )\n' > check.rst && export PATH=<guest-path> && blacken-docs --check <guest-path>; echo EXIT=$?; blacken-docs --check <guest-path>; echo EXIT=$?; sha256sum check.md check.rst
cd <guest-path> && cat > probe.json <<'EOF'
{"kind":"cli","argv":["blacken-docs","--check","<guest-path>"],"cwd":"<guest-path>","env":{"PATH":"<guest-path>"},"expected_returncode":1,"expected_text":"Requires a rewrite."}
EOF
cat > claims.json <<'EOF'
[
{"kind":"claim","claim":"blacken-docs exits nonzero when a file would be modified","source":"If any file is modified, ``blacken-docs`` exits nonzero.","input":"<guest-path> with an unformatted python block","expected":"exit code 1 and a rewrite-needed message","probe_kind":"cli","argv":["blacken-docs","--check","<guest-path>"],"env":{"PATH":"<guest-path>"},"expected_returncode":1,"expected_text":"Requires a rewrite.","cwd":"<guest-path>"},
{"kind":"claim","claim":"blacken-docs supports reStructuredText files","source":"It supports Markdown, reStructuredText, and LaTex files.","input":"<guest-path> with an unformatted python code-block","expected":"rewrite-needed message for the rst file","probe_kind":"cli","argv":["blacken-docs","--check","<guest-path>"],"env":{"PATH":"<guest-path>"},"expected_returncode":1,"expected_text":"Requires a rewrite.","cwd":"<guest-path>"}
]
EOF
python3 -m json.tool probe.json >/dev/null && python3 -m json.tool claims.json >/dev/null && echo OK
cd <guest-path> && cat > examples.json <<'EOF'
[
{"kind":"example","claim":"Repository test suite passes (tox.ini testenv command, without coverage wrapper)","source":"tox.ini [testenv] commands","input":"tests/","expected":"all tests pass","argv":["<guest-path>","-W","error::ResourceWarning","-W","error::DeprecationWarning","-m","pytest","-p","no:cacheprovider","tests"],"cwd":"<guest-path>","env":{"PYTHONDONTWRITEBYTECODE":"1","PYTHONDEVMODE":"1"},"expected_text":"76 passed"},
{"kind":"example","claim":"Check a documentation file without rewriting it","source":"README.rst Usage section","input":"README.rst","expected":"exit 0, file already formatted","argv":["blacken-docs","--check","README.rst"],"cwd":"<guest-path>","env":{"PATH":"<guest-path>"}}
]
EOF
cat > cycles.json <<'EOF'
{"detected":false,"reason":"Inspected README.rst, pyproject.toml scripts entry (blacken_docs:main) and src/blacken_docs/__main__.py entry points: blacken-docs is a one-shot CLI that processes the filenames given and exits. No scheduler, cron, loop, webhook, daemon or --once/--now mode is documented or present.","checks":[]}
EOF
python3 -m json.tool examples.json >/dev/null && python3 -m json.tool cycles.json >/dev/null && echo OK; grep -n "def main\|__main__" <guest-path> | head
ls <guest-path> 2>&1; cd <guest-path> && <env-var>=<guest-path> python3 -I <guest-path> --validate --replay 2>&1 | tail -60; echo EXIT=${PIPESTATUS[0]}
cd <guest-path> && python3 - <<'EOF'
import json
p='claims.json'
d=json.load(open(p))
for c in d:
    c['source_file']='README.rst'
json.dump(d,open(p,'w'),indent=1)
print('ok',len(d))
EOF
cd <guest-path> && <env-var>=<guest-path> python3 -I <guest-path> --validate --replay 2>&1 | tail -60; echo EXIT=${PIPESTATUS[0]}
cd <guest-path> && cat > report.json <<'EOF'
{"outcome":"working","fault_owner":null,"operation":"Run blacken-docs --check on Markdown and reStructuredText files and get the documented nonzero exit with a rewrite-needed message; run the repo test suite","operation_scope":"Local CLI from the source checkout installed into <guest-path> (Python 3.12.3, README supports 3.11-3.15). No browser, credentials or network service needed.","steps":["curl $CDP_URL/json/version returned HTTP 200 (browser not needed by this CLI)","python3 -m venv <guest-path> (Python 3.12.3)","<guest-path> -m pip install <guest-path> (installed blacken-docs 1.20.0 with black 26.10.1)","blacken-docs sample.md (in <guest-path>) rewrote the python block in place and exited 1, as documented","blacken-docs --check <guest-path> and check.rst: exit 1 with 'Requires a rewrite.'","blacken-docs --check README.rst on the repo README: exit 0","pytest tests with tox.ini warning flags: 76 passed"],"deviations":["Installed from the local source checkout with pip into a venv rather than from PyPI, so the tested code is the snapshot in <guest-path>","Snapshot is not a git checkout (no .git), so the pinned commit 8e7705218838da988c103d00ab6ecdd67dea7c37 could not be verified and no git fetch/reset was run.","tox was not used; the same pytest command was run directly with the tox warning flags and without the coverage wrapper, using -p no:cacheprovider so no cache files were written to the checkout.","Only Python 3.12 was tested; 3.11 and 3.13-3.15 were not run.","The checker default source file is README.md; the claims set source_file to README.rst because that is the repo README.","In-place rewrite was checked by hand on a scratch copy, not as a replayed claim, because a second replay would no longer find anything to rewrite."],"stuck_step":null,"main_blocker":null,"plain_failure":null,"suggested_fix":"None required; the tool works as documented."}
EOF
python3 -m json.tool report.json >/dev/null && echo REPORT_OK; cd <guest-path> && <env-var>=<guest-path> python3 -I <guest-path> --validate --replay 2>&1 | head -c 300; echo; echo EXIT=${PIPESTATUS[0]}; cd <guest-path> && ls -la && ls -la .coldpass
Earlier attempts (1)

Luna

Native agent · Recorded operation failed

Operation / attempted scope /tmp/blacken-venv/bin/blacken-docs --in-place <guest-path>

Run details
run
adamchainz--blacken-docs-gpt-6-luna-1793090292974028909
date
Oct 27, 2026
time to working
not recorded
product hosting / execution
Local command in the guest
recorded operation scope
not separately recorded
model
gpt-6-luna
agent / version
codex / codex-cli 0.164.0
platform
linux
reported cost
not reported (not assumed free)
Recorded source
https://github.com/adamchainz/blacken-docs
Backend
hyperv
Tool transport
mcp-assigned-vm
Requested source pin (not an observed revision)
{"commit": "8e7705218838da988c103d00ab6ecdd67dea7c37", "url": "https://github.com/adamchainz/blacken-docs"}
Test version
readme-38e6b13f3b13804effb95797e3466b1a1334da7a232d897cbc8965867f802605
revision
8e7705218838da988c103d00ab6ecdd67dea7c37
Current diagnosis: unknown · pending

wrong subcommand or usage-only response: {"argv": ["/tmp/blacken-venv/bin/blacken-docs", "--in-place", "<guest-path>"], "returncode": 2, "stdout": "", "stderr": "usage: blacken-docs [-h] [-l LINE_LENGTH] [--preview] [-S]\n [-t TARGET_VERSIONS] [--check] [-E] [--rst-literal-blocks]\n [--pyi]\n [filenames...]\nblacken-docs: error: unrecognized arguments: --in-place\n", "expected_file": "<guest-path>", "file_checked": false, "file_excerpt": "```python\ndef f(x):\n return(x+1)\n```\n", "needs_credentials": false, "needs_browser": false}

Repair record fix-ff7ec3e448bb2d4c2926 · current status JSON. Original run outcomes remain unchanged.

Failed run: adamchainz/blacken-docs · Oct 27, 2026 · Recorded operation failed.

Fix: fix-ff7ec3e448bb2d4c2926.

Recorded blocker / warning

Step: /tmp/blacken-venv/bin/blacken-docs --in-place <guest-path>

wrong subcommand or usage-only response: {"argv": ["/tmp/blacken-venv/bin/blacken-docs", "--in-place", "<guest-path>"], "returncode": 2, "stdout": "", "stderr": "usage: blacken-docs [-h] [-l LINE_LENGTH] [--preview] [-S]\n

Safety: No problems traced to this repository code in these checks.

No problems traced to this repository code in these checks.

Reviewed as expected for a test run: attempted writes that failed, so nothing was written.

OSV scanned supported lockfiles; unpinned dependencies and unsupported formats are outside this check.

A short run cannot establish that code is safe.

Connections show IP addresses; proxies can hide the final hostname.

Tracing covers dispatched commands and their children, not the whole OS; guest root can interfere with tracing.

Full safety evidence →

Answers recorded for this run
  • Run ``blacken-docs`` with the filenames to rewrite:: Real input did not produce the expected result: def f(x):

    Source: Run ``blacken-docs`` with the filenames to rewrite:

    Input: A Markdown Python block with non-Black formatting

    Expected: The block is formatted by Black

    Command: /tmp/blacken-venv/bin/blacken-docs --in-place <guest-path>

    Observed: ```python def f( x ): return( x+1 ) ```

Examples

  • Format a Markdown Python block using the README command: command exited with code 2

    Source: README.rst Usage

    Input: A Markdown Python block with non-Black formatting

    Expected: The block is rewritten

    Command: /tmp/blacken-venv/bin/blacken-docs --in-place <guest-path>

    Observed: ```python def f( x ): return( x+1 ) ```

Local or hosted: local

Suggested next step (agent-reported): Inspect the recorded blocker and correct the README prerequisites or harness error.