@iowarp/clio-coder 0.3.0

package/CONTRIBUTING.md

@@ -0,0 +1,224 @@
+# Contributing to Clio Coder
+
+Clio Coder is IOWarp's coding agent for supervised repository work. The
+project is in alpha: public behavior, installation paths, and release process
+may move until a stable release is announced.
+
+This repository is optimized for human reviewers and coding agents alike.
+Keep changes small, explicit, and easy to verify from git history.
+
+
+## Setup
+
+Requirements:
+
+- Node.js `>=22.19.0`
+- npm
+- Linux or macOS for full parity. Windows is best effort until a stable release.
+
+Bootstrap:
+
+```bash
+npm ci
+npm run typecheck
+npm run lint
+npm run test
+npm run build
+```
+
+Local and GitHub PR gate (fast, deterministic):
+
+```bash
+npm run ci
+```
+
+Release gate (for maintainers before tags or release artifacts):
+
+```bash
+npm run ci:release
+```
+
+Live LLM smoke validation (manual/opt-in):
+
+```bash
+CLIO_CODER_LIVE_SMOKE=1 CLIO_CODER_LIVE_TARGET=anthropic ANTHROPIC_API_KEY=your_key npm run test:live
+```
+
+## Testing conventions
+
+CLI-facing contract tests drive the built binary through the child-process
+harness in `tests/harness/spawn.ts`: `makeScratchHome()` gives the run an
+isolated `CLIO_CODER_HOME`, and `runCli(args, { env, cwd })` spawns `dist/cli` and
+returns its captured `stdout`, `stderr`, and exit code. Rebuild `dist/` with
+`npm run build` after changing CLI source, since these tests exercise the
+built output.
+
+Do not assert a CLI subcommand's output by capturing `process.stdout.write`
+in-process. In-process stdout capture fights the node:test spec reporter:
+async flushes land in the capture buffer and the reporter's pass/fail counters
+get eaten, so a passing test can report as no output. Spawn the CLI through the
+harness instead. Patching `process.stdout`/`stderr` to assert a small library
+function's own output is fine; the trap is capturing a whole subcommand's
+output in-process while the reporter runs.
+
+## Releasing
+
+Releases are tag-driven and publish from CI. Nothing is published from a
+workstation.
+
+1. Bump `version` in `package.json` and retitle the `unreleased` section in
+   `CHANGELOG.md` to the version being cut.
+2. Run `npm run ci:release`. It runs the full `ci` gate, then
+   `scripts/check-release.mjs`, which verifies the built `dist/` and audits
+   the exact npm package contents.
+3. Land the release commit through the normal PR flow.
+4. Tag and push: `git tag vX.Y.Z && git push origin vX.Y.Z`. The tag must
+   match `package.json`'s version; the release workflow refuses mismatches.
+5. `.github/workflows/release.yml` verifies the tag against `package.json`,
+   reruns the full gate, and creates the GitHub release with the tarball
+   attached. The npm publish step runs only when the repository variable
+   `NPM_PUBLISH` is `true` and the `NPM_TOKEN` secret holds an automation
+   token that can publish `@iowarp` packages; with the variable unset the
+   step is skipped and the GitHub release is still created. A maintainer may
+   run the first publish manually (`npm login && npm publish`);
+   `prepublishOnly` runs the same `ci:release` gate either way.
+
+What `scripts/check-release.mjs` enforces, and how to respond when it fails:
+
+- Only `dist/cli/index.js` and `dist/worker/entry.js` carry a shebang. The
+  shebang comes from the hashbang line in each entry source file. Never add
+  a tsup `banner`; it would stamp every chunk in `dist/`.
+- The package ships no source maps, benchmarks, caches, or repo scripts. If
+  a forbidden file appears, fix the `files` allowlist in `package.json`
+  rather than deleting the file from the repo.
+- Runtime resources must resolve from the installed package root: prompt
+  fragments, builtin agents, model catalogs, `docs/html`, the 128px logo,
+  and `damage-control-rules.yaml`. A new runtime resource must be listed in
+  both package.json `files` and the required list in `check-release.mjs`.
+  The double bookkeeping is deliberate: neither edit can silently drop a
+  resource the CLI needs at runtime.
+- Size budgets: 2 MB tarball, 6 MB unpacked. If a legitimate change exceeds
+  them, raise the budget in the same PR with a justification, never as a
+  drive-by.
+
+Build shape, for anyone changing `tsup.config.ts`: two ESM entries with code
+splitting on. `src/cli/index.ts` imports every subcommand dynamically, so a
+command pays only for its own chunk and `clio-coder --version` stays fast. Keep new
+subcommands behind dynamic imports, and keep heavyweight runtime dependencies
+in the `external` list so they load from `node_modules` only when a chunk
+that needs them runs.
+
+## Hard Rules
+
+1. Do not push to `main`.
+2. Open pull requests against `main`.
+3. `main` requires review by `@akougkas`.
+4. Keep every PR focused. Split unrelated docs, runtime, CLI, and TUI work.
+5. Update `CHANGELOG.md` for user-visible behavior, developer workflow, or
+   release status changes.
+6. Run `npm run ci` before requesting review.
+7. Do not commit secrets, local config, generated `dist/`, or scratch plans.
+
+## Architecture Invariants
+
+The boundary checker enforces these:
+
+- Engine boundary: only `src/engine/**` value-imports pi SDK packages
+  (`@earendil-works/pi-*`, pinned in `package.json`).
+- Worker isolation: `src/worker/**` value-imports only the worker-safe
+  provider runtime rehydration modules under `src/domains/providers/**`;
+  all other worker domain imports must be type-only.
+- Domain independence: cross-domain flows go through `SafeEventBus`.
+
+Run:
+
+```bash
+npm run check:boundaries
+```
+
+## Branches
+
+Use short branch names:
+
+- `feat/<topic>`
+- `fix/<topic>`
+- `docs/<topic>`
+- `test/<topic>`
+- `chore/<topic>`
+
+Examples:
+
+- `feat/worker-profiles`
+- `fix/session-resume-replay`
+- `docs/github-governance`
+
+## Commits
+
+Use concise conventional subjects:
+
+```text
+feat(cli): add target profile flag
+fix(session): restore chat on fork
+docs(changelog): record v0.1.0-exp release notes
+```
+
+Rules:
+
+- Types: `feat`, `fix`, `docs`, `test`, `refactor`, `build`, `ci`, `chore`.
+- Optional scope is encouraged.
+- Subject <= 72 characters.
+- Explain why in the body when behavior or architecture changes.
+- Use ASCII punctuation in docs and commits.
+
+## Pull Requests
+
+PRs should include:
+
+- Problem and approach.
+- User-facing behavior changes.
+- Tests run.
+- Changelog/status updates, or why none are needed.
+- Screenshots only for visible TUI changes when useful.
+
+Review rubric:
+
+- Correctness: behavior matches the stated problem.
+- Boundaries: architecture invariants still hold.
+- Safety: no secret leakage, unsafe shell behavior, or destructive defaults.
+- Tests: coverage matches the risk and changed surface.
+- Docs: changelog/status/contributor guidance stays current.
+
+## Agent Etiquette
+
+Agents should:
+
+- Read `CLIO-CODER.md`, `CHANGELOG.md`, and this file before broad
+  edits.
+- Prefer `rg` for search.
+- Use existing modules and helpers before adding abstractions.
+- Keep generated summaries short and cite git ranges when summarizing history.
+- Avoid touching unrelated files in a dirty worktree.
+- Leave remote writes, branch rules, and release tags to `@akougkas` unless
+  explicitly instructed.
+
+## Skills
+
+`skills/` is the curated skills marketplace: maintainer-approved `SKILL.md`
+guides, distinct from the runtime skills any user can drop into a discovery
+root. It is not itself a discovery root, so nothing here auto-loads; skills
+activate only via `clio-coder skills install <name>`.
+
+To propose a skill:
+
+1. Add `skills/<name>/SKILL.md`. Follow the `superpowers:writing-skills`
+   methodology and Anthropic's skill-authoring guidance: a trigger-rich
+   `description` (third person, "Use when ..."), one excellent example, and
+   progressive disclosure (push heavy reference into `references/`).
+2. Include the provenance frontmatter (`registry-id`, `source-url`, `version`,
+   `license`) and ship an `evals.md` with the baseline scenarios you tested.
+3. Verify locally: `clio-coder skills validate skills/<name>/SKILL.md`, then
+   `clio-coder skills install <name>` and `clio-coder skills list`.
+4. Open a PR. A maintainer reviews against the rubric, then sets `audit: pass`
+   and the `version` to approve it for the catalog.
+
+Full catalog conventions and install options: [skills/README.md](skills/README.md).

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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/NOTICE

@@ -0,0 +1,9 @@
+Clio Coder
+Copyright 2026 Anthony Kougkas and the IOWarp project contributors
+
+This product is part of the IOWarp CLIO ecosystem of agentic science
+(https://iowarp.ai), developed at the Gnosis Research Center,
+Illinois Institute of Technology.
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file
+distributed with this work for the full license text.