cctally 1.2.0

package/CHANGELOG.md

@@ -0,0 +1,169 @@
+# Changelog
+
+All notable changes to this project are documented in this file. Format is
+based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [Unreleased]
+
+## [1.2.0] - 2026-05-08
+
+### Added
+- npm distribution channel — `npm install -g cctally` lands the
+  Python script and dashboard assets via a thin Node shim. `package.json`
+  at the public-repo root, version stamped by Phase 1 alongside CHANGELOG.md.
+- Homebrew distribution channel — `brew install omrikais/cctally/cctally`
+  via a separate `omrikais/homebrew-cctally` tap. Formula
+  `depends_on "python@3.13"` and pins cctally's shebang to that keg.
+- `cctally release` Phase 5 (npm publish) and Phase 6 (brew formula bump),
+  idempotent and resume-aware. `--skip-npm` / `--skip-brew` flags for
+  outage workarounds. Pre-releases publish to npm under `--tag next`;
+  brew skips pre-releases.
+
+### Fixed
+- `bin/cctally-mirror-public` now classifies each commit's paths under
+  the `.mirror-allowlist` that lived in THAT commit's tree, matching the
+  commit-msg hook's at-commit-time semantics. Previously the mirror tool
+  read HEAD's allowlist and retroactively flagged historical commits
+  that added a path before a later commit promoted it to public — even
+  when the author followed the documented "add file → then add to
+  allowlist" sequencing and the hook accepted both commits. Authors saw
+  green at commit time and red at release time. The fix evaluates each
+  commit against the allowlist that lived at that commit's tree,
+  matching the commit-msg hook.
+- `cctally release` Phase 6 done-check is now remote-authoritative
+  AND verifies the tap default-branch tip. Done-check runs three
+  predicates: the local formula contains `/v<version>.tar.gz`, the
+  tap origin carries `refs/tags/v<version>`, and the local clone's
+  HEAD SHA equals the remote default-branch SHA. Without the
+  branch-tip leg, a half-failed push (tag landed, branch did not)
+  could mark Phase 6 done while `brew install` — which reads the
+  formula from the default branch, not from the tag — still served
+  the prior version. Resume after any push failure detects the
+  local-but-not-remote state and re-pushes without re-rendering or
+  re-committing.
+- `cctally release` Phase 6 push is now atomic: a single
+  `git push --atomic origin HEAD refs/tags/v<version>:refs/tags/v<version>`
+  replaces the previous separate branch + tag pushes. Both refs land
+  or neither, eliminating the half-failed-push asymmetry at the
+  source. Lightweight tag (no `-a`/`-m`) still works because the tag
+  refspec is explicit.
+- `cctally setup` hook commands now route through the same
+  channel-aware resolver used for the `cctally` symlink, so npm
+  installs get the Node shim path in `~/.claude/settings.json`
+  instead of the Python script directly. Without this, npm users who
+  set `CCTALLY_PYTHON` (because system `python3` is below 3.13) had
+  working interactive `cctally` invocations but every Claude Code
+  hook fire bypassed `CCTALLY_PYTHON` via the script's
+  `/usr/bin/env python3` shebang and silently failed. brew installs
+  are unaffected (formula pins `python@3.13`).
+- `cctally setup` no longer symlinks `~/.local/bin/cctally` to the
+  Node shim during a source-clone install. Resolver previously selected
+  `bin/cctally-npm-shim.js` whenever the file was present; since the
+  shim is checked into the source tree, source clones (documented as
+  Python-only) on a host without Node would have a broken `cctally`
+  on PATH. Selection now requires `repo_root` to live under a
+  `node_modules/` directory — the canonical npm install layout.
+
+## [1.1.0] - 2026-05-07
+
+### Added
+- `bin/cctally-mirror-public --accept-skip-mismatch` flag — overrides
+  the refuse gate when accumulated public-skip diffs significantly
+  exceed the current publish commit's diff (long-skip-chain plus
+  fix/chore-typed publish subject). Default behavior gains an
+  `⚠ ACCUMULATED-DIFF MISMATCH` block surfacing warn-severity findings
+  (max-ratio greater than 3× plus non-feat subject) and a hard refuse
+  on the chain-greater-than-15 plus max-ratio-greater-than-5× case;
+  the flag is the documented escape hatch for refuse situations the
+  operator has reviewed and accepted.
+- SQLite migration framework for `stats.db` and `cache.db` — per-DB
+  registry populated via `@stats_migration` / `@cache_migration`
+  decorators with contiguous `NNN_descriptive_name` ordering enforced
+  at script load. Dispatcher handles fresh-install detection, bootstrap
+  rename of pre-framework markers, per-migration `BEGIN`/`COMMIT`
+  ownership, first-failure halts, and `PRAGMA user_version` fast-path.
+- `cctally db status` — per-DB list of applied / pending / failed /
+  skipped migrations with `--json` output. Glyphs: `✓` applied,
+  `✗` failed, `·` pending, `~` skipped.
+- `cctally db skip <name> [--reason …]` — manual escape for
+  migrations that genuinely cannot succeed on a particular machine
+  (e.g., poison pills). Skipped migrations are bypassed by the
+  dispatcher; they do not run.
+- `cctally db unskip <name>` — removes the skip mark and invalidates
+  the `user_version` fast-path so the migration retries on next open.
+- Uniform migration error sentinel: `migration-errors.log` shared by
+  both DBs (cache.db entries prefixed `cache.db:<name>`); banner
+  renders on the next interactive command and auto-clears when the
+  same migration succeeds again.
+- `bin/_sqlite-diff.py` — stdlib `sqldiff` fallback for goldens
+  harnesses; includes `PRAGMA user_version` so framework correctness
+  conditions surface in the diff.
+- `bin/cctally-migrations-test` — 12 framework-mechanics scenarios
+  spanning fresh install, partial-marker upgrade, failure → banner →
+  clear cycle, downgrade detection, skip / unskip semantics, both-DB
+  end-to-end, legacy-marker recognition by `db status`, post-backfill
+  5h-dedup re-run, and skip-honored post-backfill semantics. Includes
+  a lazy-adopted per-migration goldens loop under
+  `tests/fixtures/migrations/per-migration/<NNN_name>/{pre,post}.sqlite`.
+- `cctally setup` — one-command install: symlinks user-facing binaries into
+  `~/.local/bin/` and adds additive hook entries (`PostToolBatch`, `Stop`,
+  `SubagentStop`) to `~/.claude/settings.json`. Includes `--dry-run`,
+  `--status`, `--uninstall`, `--uninstall --purge` modes.
+- `cctally hook-tick` — internal per-fire runtime invoked by Claude Code
+  hooks. Reads CC hook payload from stdin, runs `sync_cache`, conditionally
+  refreshes OAuth usage (default 30s throttle).
+- `~/.local/share/cctally/logs/hook-tick.log` — rotating per-fire log
+  (1 MB cap, single-generation rotation).
+- `~/.local/share/cctally/hook-tick.last-fetch` — OAuth throttle marker
+  (sentinel file owned by hook-tick).
+- Fixture harnesses: `bin/cctally-setup-test` (13 scenarios) and
+  `bin/cctally-hook-tick-test` (7 scenarios), both wired into
+  `bin/cctally-test-all`.
+- Spec: `docs/superpowers/specs/2026-05-06-migration-framework-design.md`.
+  Reference page: `docs/commands/db.md`.
+
+### Changed
+- The three pre-framework data-shape migrations
+  (`001_five_hour_block_models_backfill_v1`,
+  `002_five_hour_block_projects_backfill_v1`,
+  `003_merge_5h_block_duplicates_v1`) are now framework-managed.
+  Existing DBs auto-rename their legacy unprefixed marker rows on the
+  next open via the dispatcher's bootstrap path; both `cctally db
+  status` and `cctally db skip` recognize legacy names as applied
+  even before the bootstrap has run.
+- Column additions still go through the existing
+  `add_column_if_missing(conn, table, column, decl)` idempotent
+  guard — that sibling pattern is unchanged. The migration framework
+  is for data-shape changes (backfill, dedup, rename, FK rewrite)
+  only.
+- Default integration is now hook-based. The legacy status-line snippet
+  (`cctally record-usage` from `~/.claude/statusline-command.sh`) is no
+  longer the recommended path but **remains fully supported** as an opt-in
+  alternative documented in `docs/commands/record-usage.md`.
+- `docs/installation.md` rewritten around `cctally setup`.
+
+### Fixed
+- Skip-chain metrics now preserve the chain across clean `--no-ff`
+  merges, matching the mirror's auto-skip-clean-merges behavior. A
+  `--- public ---` block on a clean merge previously flushed the
+  accumulated chain in metrics (while the mirror kept accumulating),
+  letting a later `fix:` publish bypass the warn/refuse guard.
+- `cctally release --resume` now detects an existing Phase-1 stamp
+  even when the resume runs on a different UTC date than the original
+  stamp. Previously the done-signal compared `## [version] - <today>`
+  against the CHANGELOG's recorded date, so a next-day resume would
+  miss the stamp and re-attempt Phase 1 on an empty `[Unreleased]`,
+  blocking the documented idempotent-resume contract.
+- `cctally release` preflight git probes (branch, clean-tree, fetch,
+  ahead/behind, tag-clobber) and Phase-2 tag-existence probe now run
+  with `cwd=` anchored to the cctally repo. Invocations from outside
+  the checkout (e.g., the `cctally-release` symlink in `~/.local/bin/`
+  with the operator's shell in another git repo) previously read the
+  caller's CWD for these checks while later phases wrote to the cctally
+  repo, allowing a clean `main` elsewhere to satisfy preflight against
+  the wrong upstream.
+
+## [1.0.0] - 2026-05-06
+
+### Added
+- Initial public release of cctally (mirror bootstrap).

package/LICENSE

@@ -0,0 +1,204 @@
+Copyright 2026 Omri Kaisari
+
+
+                                 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.

package/README.md

@@ -0,0 +1,144 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/img/logo-dark.png">
+    <img src="docs/img/logo-light.png" alt="cctally" width="600">
+  </picture>
+</p>
+
+<p align="center">
+  <strong>Track Claude Code subscription usage as a weekly $-per-1% trend. Local web dashboard, terminal UI, forecasts, and threshold alerts.</strong>
+</p>
+
+If you're using `ccusage` to watch Claude Code spend, `cctally` covers the same ground and adds the parts you reach for next: a live web dashboard, a forecast that tells you whether you're going to cap this week, threshold alerts when you cross a percent, and a persistent week-over-week trend of cost per percent of quota. All local, no account, no telemetry.
+
+<p align="center">
+  <img src="docs/img/dashboard-desktop.png" alt="cctally dashboard, desktop view" width="900">
+</p>
+
+## Installation
+
+**Requirements:** Python 3.13+, macOS or Linux, Claude Code installed and run at least once.
+
+### Homebrew (macOS / Linux)
+
+```bash
+brew install omrikais/cctally/cctally
+cctally setup
+```
+
+### npm
+
+```bash
+npm install -g cctally
+cctally setup
+```
+
+The npm package is a thin Node shim around the bundled Python script — no postinstall, no native build. Set `CCTALLY_PYTHON=/path/to/python3` if `python3` isn't on your PATH.
+
+### From source
+
+```bash
+git clone https://github.com/omrikais/cctally
+cd cctally
+./bin/cctally setup
+```
+
+`cctally setup` (any channel) symlinks the binaries into `~/.local/bin/`, adds three additive hooks to `~/.claude/settings.json` (never overwrites existing entries), and bootstraps the local SQLite cache. If `~/.local/bin/` isn't on your PATH, the script prints the line to add.
+
+```bash
+cctally setup --status     # verify hooks + symlinks
+cctally daily              # cost-by-day, your first table
+cctally dashboard          # opens http://127.0.0.1:8789
+```
+
+For status-line integration, alerts, and configuration, see [docs/installation.md](docs/installation.md) and [docs/configuration.md](docs/configuration.md).
+
+## What it looks like
+
+### Dashboard
+
+<table>
+  <tr>
+    <td>
+      <img src="docs/img/dashboard-modal.png" alt="Dashboard with trend modal open">
+      <br><em>Any panel expands into a focused view. The trend modal shows twelve weeks of cost per percent.</em>
+    </td>
+    <td>
+      <img src="docs/img/dashboard-warn.png" alt="Dashboard in warn state">
+      <br><em>When the forecast projects a cap before the weekly reset, the modal goes amber.</em>
+    </td>
+  </tr>
+  <tr>
+    <td colspan="2" align="center">
+      <img src="docs/img/dashboard-mobile.png" alt="Dashboard on phone" width="350">
+      <br><em>The same dashboard on your phone.</em>
+    </td>
+  </tr>
+</table>
+
+### CLI tables
+
+<p align="center">
+  <img src="docs/img/cli-report.svg" alt="cctally report: $ per 1% weekly trend">
+  <br>
+  <em>Weekly cost as dollars per percent of quota, with the delta against the prior week.</em>
+</p>
+
+<p align="center">
+  <img src="docs/img/cli-forecast.svg" alt="cctally forecast: will I cap this week?">
+  <br>
+  <em>Projected percent at the weekly reset, plus the daily budget to stay under the cap.</em>
+</p>
+
+<p align="center">
+  <img src="docs/img/cli-five-hour-blocks.svg" alt="cctally five-hour-blocks: 5h analytics with model breakdown">
+  <br>
+  <em>Each 5-hour window, broken down by model.</em>
+</p>
+
+### Live terminal
+
+<p align="center">
+  <img src="docs/img/cli-tui.svg" alt="cctally tui: live terminal dashboard">
+  <br>
+  <em>The same data in the terminal, refreshed live.</em>
+</p>
+
+## What cctally adds
+
+`cctally` started as a local-first replacement for [`ccusage`](https://github.com/ryoppippi/ccusage), and it stays compatible at the level of common CLI flows (`daily`, `monthly`, `weekly`, `session`, `blocks`). Beyond that, it adds:
+
+- **Live web dashboard.** Nine-panel SSE-driven view at `localhost:8789` (current week, forecast, trend, sessions, weekly, monthly, blocks, daily, recent alerts), with per-panel modals, a mobile layout, threshold alerts, and a settings drawer.
+- **TUI live mode.** The same data inside your terminal (`cctally tui`; requires the optional `rich` package).
+- **$-per-1% weekly trend.** The `report` table reframes weekly cost as cost-per-percent-of-quota, so spending efficiency is visible week over week.
+- **Forecast.** Projects current-week percent and daily $/% budgets against the 100% and 90% ceilings (`cctally forecast`).
+- **Threshold alerts.** Configurable percent crossings with native macOS popups (`cctally alerts`).
+- **5-hour block analytics.** Per-block usage with model and project breakdowns (`cctally five-hour-blocks --breakdown=model`).
+- **Time-window diff.** Compare two windows with model and project decomposition (`cctally diff`).
+- **Project rollup.** Usage by Git project (`cctally project`).
+- **Codex parity.** Drop-in replacements for `ccusage-codex daily / monthly / session`, plus an added `cctally codex-weekly` rollup (upstream has no `codex weekly`).
+- **Persistent SQLite.** Week-over-week comparisons survive across runs.
+
+**On speed.** Pricing is embedded and computed at query time from a delta-tail SQLite cache (`~/.local/share/cctally/cache.db`), with no shell-outs. First-table latency on 30 days of session data: **~2.6s (cctally) vs ~31s (ccusage)**, about 12× faster. Measured by `bench/cctally-vs-ccusage.sh` on macOS arm64, 2026-05-05; your numbers will vary.[^bench]
+
+<!--
+  Footnote target uses an absolute URL because GitHub's relative-link
+  rewriter doesn't traverse into GFM footnote `<li>` content; on the
+  repo home page (`/omrikais/cctally`, no trailing slash) the browser
+  would resolve `bench/README.md` against the page URL and produce
+  `/omrikais/bench/README.md` — a broken path. Regular paragraph links
+  are unaffected.
+-->
+[^bench]: Methodology and reproduction: [`bench/README.md`](https://github.com/omrikais/cctally/blob/main/bench/README.md).
+
+## Documentation
+
+- [Installation](docs/installation.md): symlinks, status-line wiring, Python version.
+- [Configuration](docs/configuration.md): `config.json` shape and week-start rules.
+- [Architecture](docs/architecture.md): data flow, caches, week boundaries.
+- [Runtime data](docs/runtime-data.md): what lives in `~/.local/share/cctally/`.
+- [Command reference](docs/commands/): one page per subcommand.
+
+## License
+
+Apache 2.0. See [`LICENSE`](LICENSE).