Document Go CLI migration state and usage

README.md

@@ -1,3 +1,70 @@
 # APM – Agent Package Manager
 
 Experimental go migration of APM.
+
+## Go CLI migration status
+
+The Python-to-Go CLI migration is now landed but still intentionally keeps both
+implementations in the tree:
+
+- The Python CLI remains the reference implementation and parity oracle.
+- The Go CLI lives under `cmd/apm` and can be built as a local `apm-go` binary.
+- The Crane migration PR was merged in
+  [githubnext/apm#91](https://github.com/githubnext/apm/pull/91), and the
+  migration issue is marked `crane-completed` in
+  [githubnext/apm#78](https://github.com/githubnext/apm/issues/78).
+- The restored migration workflow verifies Python-vs-Go parity with
+  `APM_PYTHON_BIN` set. Latest verified parity evidence reports
+  `migration_score=1`, `progress=1`, and `706/706` parity tests passing.
+- The benchmark workflow follow-up in
+  [githubnext/apm#93](https://github.com/githubnext/apm/pull/93) uploads a
+  `migration-benchmark-evidence` artifact with Python-vs-Go CLI timings.
+
+This means Python unit tests and Go parity tests pass for the migration gate.
+That gate is not the same thing as claiming all historical Python integration,
+live-service, and benchmark coverage is now green for every workflow.
+
+### Build and run the Go CLI locally
+
+From the repository root:
+
+```bash
+go build -o ./dist/apm-go ./cmd/apm
+```
+
+Then try the local binary:
+
+```bash
+./dist/apm-go --help
+./dist/apm-go init --yes
+```
+
+### Run the definitive parity check locally
+
+When the Python CLI is installed in the project virtual environment, run:
+
+```bash
+uv sync --extra dev
+export APM_PYTHON_BIN="$PWD/.venv/bin/apm"
+go test ./...
+go test -json ./... | go run .crane/scripts/score.go
+```
+
+`APM_PYTHON_BIN` is required for the hard Python-vs-Go parity gate; without it,
+Go-only tests are not completion evidence.
+
+### Run the Actions parity and benchmark workflow
+
+Maintainers can dispatch the migration workflow manually:
+
+```bash
+gh workflow run migration-ci.yml --repo githubnext/apm --ref main
+```
+
+After it runs, open the **Migration Benchmarks** job summary for the timing
+table. The same run uploads the `migration-benchmark-evidence` artifact with
+JSON and Markdown copies of the benchmark data. In the benchmark table, the
+`Go/Python` ratio is the Go median duration divided by the Python median
+duration: values below `1.00x` mean Go is faster. Recent smoke benchmark
+evidence for startup/help/init-style commands shows the Go CLI roughly
+`327x`-`370x` faster than the Python CLI.

tests/unit/test_readme_go_cli_migration.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+ROOT = Path(__file__).resolve().parents[2]
+
+
+def test_readme_documents_go_cli_migration_usage() -> None:
+    readme = (ROOT / "README.md").read_text(encoding="utf-8")
+
+    required_snippets = [
+        "The Python CLI remains the reference implementation and parity oracle.",
+        "The Go CLI lives under `cmd/apm`",
+        "githubnext/apm#91",
+        "githubnext/apm#78",
+        "githubnext/apm#93",
+        "go build -o ./dist/apm-go ./cmd/apm",
+        "./dist/apm-go --help",
+        "./dist/apm-go init --yes",
+        'export APM_PYTHON_BIN="$PWD/.venv/bin/apm"',
+        "go test -json ./... | go run .crane/scripts/score.go",
+        "gh workflow run migration-ci.yml --repo githubnext/apm --ref main",
+        "`migration-benchmark-evidence`",
+        "`Go/Python` ratio is the Go median duration divided by the Python median",
+        "`327x`-`370x` faster",
+    ]
+
+    for snippet in required_snippets:
+        assert snippet in readme
+
+
+def test_readme_distinguishes_parity_gate_from_full_historical_coverage() -> None:
+    readme = (ROOT / "README.md").read_text(encoding="utf-8")
+
+    assert (
+        "`migration_score=1`, `progress=1`, and `706/706` parity tests passing"
+        in readme
+    )
+    assert (
+        "That gate is not the same thing as claiming all historical Python integration,"
+        in readme
+    )
+    assert "`APM_PYTHON_BIN` is required for the hard Python-vs-Go parity gate" in readme