@chipschat/opencode 0.0.0-stage → 1.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+              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 2026 The Chips Authors
+
+   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

@@ -1,3 +1,129 @@
-# Temporary Holding Version
+# chips-opencode
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[OpenCode](https://opencode.ai) as a [Chips](https://chipschat.ai) harness, on OpenCode's own V2
+server (`opencode serve`, 2.0).
+- Each OpenCode agent you name (`build`, `plan`, or one of your own) is a Chips agent. The first is
+  the harness's Main agent.
+- Each Chips room an agent is in is an OpenCode session of that agent, made the first time somebody
+  there speaks to it. It shows in OpenCode's own apps too.
+- A new agent a person asks for in a room (Add, then a new one) runs as the first OpenCode agent,
+  in a session of its own.
+- A copy of an agent a person asks for in another room (Fork) is a copy of its session in its own
+  room, in the same folder: it remembers what the agent did there, and from then on the two
+  remember apart.
+
+Apache-2.0. Not published: a local repository until Chips's SDK is.
+
+## What Chips shows
+
+| In Chips | From OpenCode (`/api`) |
+| --- | --- |
+| A message to the agent | `POST /api/session/{id}/prompt`: the room note, what was said, the words |
+| The run | the session's work from `session.inbox.delivered` of those words to `session.execution.succeeded`, `failed` or `interrupted` |
+| The thinking bubble's words | `session.reasoning.ended`, `session.text.ended` on the way, a retry's `session.status` |
+| Steps, drawn by kind | `session.tool.called` / `success` / `failed`, by OpenCode's call id |
+| A sub-agent | the `subagent` call as a handoff step; its child session's cost and asks are the run's |
+| The reply | the words of the session's last answer |
+| Files in the reply | each `MEDIA:<path>` line of its own in the answer, taken out of the words and sent from the session's folder (the agent's own), as OpenCode says it (each turn is told how); a file outside it is refused, and the reply says so |
+| Cost and tokens | each model call's `session.step.ended`: OpenCode's own cost, as a step's share |
+| The context gauge | the last call's tokens against the model's window from `GET /api/model` |
+| An approval card | `permission.asked` → `POST …/permission/{id}/reply`: `always` when a person said always, else `once`; `reject` with their reason for a no. One answered in OpenCode's own apps is settled in Chips (ADR 0079) |
+| A question | a `form.created` whose fields are choices or yes-or-no, at most four → `POST …/form/{id}/reply` |
+| Stop | `POST …/interrupt`, and the words OpenCode hasn't taken yet taken back |
+| A steer, a follow-up, an interrupt | a prompt with `delivery: "steer"`; with `"queue"`; interrupt, then a prompt |
+| Fork (Chips ADR 0087): a copy of an agent in another room | `POST /api/session/{id}/fork` of the agent's session in its room, which copies what it remembers; then `PATCH /api/session/{id}` names the copy for its room and marks it as the copy's. The copy is registered after it (*Nova · fork* for Nova), `forkedFrom` the original, for the room asked, and works in the original's folder. An ask heard again registers the same copy; an agent that never spoke in its room is copied as a new one with nothing to remember |
+| Not right? on an agent's reply (Chips ADR 0200), or a 👎 from an older device | a run of the agent who said it, in its session for the room, after its turns there: a prompt with its reply, what wasn't right, and to answer again in its place; the goal is *Looking again:* and the note's first line. A 👍, or any other reaction, is nothing |
+| Trouble on the harness | `GET /api/info` every 30 s |
+
+OpenCode asks before anything its config and the agent don't allow (its rules fall back to "ask"),
+so its permission asks reach Chips as cards. An `always` there is saved by OpenCode as well.
+
+When the event stream drops, OpenCode doesn't replay what was missed. When it's back, the bridge
+reads each turn's session: which words were taken, whether it is still working, and how its last
+answer ended.
+
+Not yet:
+- Free-text, number and link form fields, and forms of more than four. These are answered in
+  OpenCode's own apps.
+- A question answered in OpenCode's own apps stays open in Chips. The protocol has no way to take
+  one back yet.
+- OpenCode's models as the agent's Model group in Chips. Its commands, skills and context files.
+- Fork for a bridge that joined from the gallery: its card grants `agents` and `new_agents`. A
+  bridge that joins with a code asks for `forks` as well.
+- More than one OpenCode server per bridge.
+
+## From Chips's gallery
+
+The card's line is `chips connect opencode '<link>'` (Chips ADR 0218). It downloads this bridge as the npm package
+`@chipschat/opencode`, the newest 1.x, checks it against the registry's checksum, and runs it on the Node
+that Chips carries, so the machine needs no Node or npm of its own. The bridge checks OpenCode,
+joins, and keeps itself running from login. `chips disconnect opencode` stops it. On another computer,
+`curl -fsSL https://chipschat.ai/install | sh -s -- connect opencode '<link>'` installs Chips there
+first. The steps below run the bridge from this checkout instead, to work on it.
+
+## Run it
+
+1. Install OpenCode (opencode.ai), and `npm install` once in this repository.
+
+2. Join Chips once, with a link from Chips's gallery (Add an agent → OpenCode), whose card gives
+   this line with the link in it:
+
+   ```
+   cd ~/Work/Chips/chips-opencode && CHIPS_JOIN_LINK='<link>' npm run keep
+   ```
+
+   The bridge runs OpenCode's server itself (`opencode serve` on `127.0.0.1`, 4096 when it is
+   free), with a password it makes and keeps in `~/.chips-opencode/server.json`, readable by you
+   only: nobody starts a server or makes up a password. While the bridge runs, a server that stops
+   is started again; when the bridge stops, so does its server.
+
+   Before it takes the link up, which works once, it checks OpenCode is installed and its server
+   answers; anything missing stops it with what to do, and the link is still good. Joined, it
+   writes a launch agent (`~/Library/LaunchAgents/chat.chips.opencode.plist`; a systemd user unit
+   on Linux) that runs the bridge from login and again whenever it stops, and ends; the kept copy
+   says hello in its room once, which the card waits for. Its log is
+   `~/Library/Logs/chips-opencode.log`. `npm run keep -- --stop` stops it and removes the file.
+   `npm start` is the same without keeping it, in the terminal. Stop a copy started by hand first:
+   two answer twice. The key Chips gives it is kept; a new link from Chips replaces it. Or join with
+   `CHIPS_URL` and a code a person allows.
+
+3. Optionally, name the agents in `~/.chips-opencode/config.json` (see `config.example.json`).
+   Without a config it is OpenCode's `build` agent, named OpenCode.
+
+   Each agent's sessions work in a folder of its own, `~/chips-opencode/agents/<its name>`, made
+   the first time it is spoken to and kept after a rename; `folders` moves them. A `directory`
+   puts every session in that one project instead, a repository the agents share.
+
+   **A server of your own.** To use an `opencode serve` you run yourself, give its password in the
+   environment variable `passwordEnv` names (`OPENCODE_PASSWORD` by default, never in the file),
+   and its `url` in the config when it isn't `127.0.0.1:4096`. `npm run keep` takes the password
+   with it, in a file only you can read; your server is kept running your own way.
+
+## Tests
+
+```
+npm test
+```
+
+They run the bridge against Chips's conformance fake and a scripted OpenCode server
+(`test/fake-opencode.ts`), on OpenCode's own routes and event shapes. That includes Chips's golden
+scenario. The SDK and the kit are in `vendor/`, packed from a Chips checkout with
+`pnpm release:sdk <this repo>/vendor`.
+
+```
+npm run e2e
+```
+
+The gallery's card for this connector, run as a person runs it, against a scratch Chips from a
+Chips checkout (`CHIPS_REPO`, `~/Work/Chips/chips-main` unless set; skipped without one) and the same scripted OpenCode.
+Each thing not set up stops it with the link still good; then it joins with what the card grants,
+says hello once in its room, says nothing more started again, and takes up a new link in place of
+the key it kept. The scratch Chips, the link and the run come from Chips's `tools/connect-kit`, which packs this checkout and serves it from a stand-in npm registry, so the card's `chips connect` downloads, checks and runs what would be published.
+
+## Release
+
+`npm run release` builds `dist/main.js`, one file with the SDK and everything else bundled in, and
+`dist/THIRD-PARTY-NOTICES.md` beside it; runs the tests; and packs `chipschat-opencode-<version>.tgz`. `npm publish`
+publishes it. A version's major is the Chips protocol it speaks, and Chips's card names that major
+(Chips ADR 0218): a fix is a minor or a patch, and reaches every card of its major the day it is
+published.