@openwop/cli 0.1.2 → 0.2.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 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 David Tufts and openwop contributors
+
+   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,6 +1,8 @@
 # OpenWOP CLI
 
-The OpenWOP CLI is the local control plane for the `apps/workflow-engine` demo app and a lightweight client for OpenWOP-compatible hosts.
+The OpenWOP CLI is the local control plane for the [OpenWOP](https://github.com/openwop/openwop) demo app (`apps/workflow-engine`, live at [app.openwop.dev](https://app.openwop.dev)) and a lightweight client for any OpenWOP-compatible host.
+
+This is the standalone home of the `@openwop/cli` package; it ships independently of the [`openwop/openwop`](https://github.com/openwop/openwop) spec corpus.
 
 ## Install
 
@@ -12,25 +14,21 @@ curl -fsSL https://openwop.dev/install.sh | bash
 
 Or directly: `npm i -g @openwop/cli` (needs Node 22+), then `openwop onboard`.
 
-From a repo clone the CLI is a TypeScript package — build it once, then run the bundled entry (or `npm run cli -- <command>` from the repo root, which builds first):
-
-```bash
-npm --prefix cli install && npm --prefix cli run build   # → cli/dist/openwop.js
-```
-
 ## Quick start
 
 ```bash
-node cli/dist/openwop.js --help
-node cli/dist/openwop.js doctor                 # check prerequisites
-node cli/dist/openwop.js onboard                # guided setup (host + provider + key + model)
-node cli/dist/openwop.js demo start             # boot local backend + frontend (optional)
-node cli/dist/openwop.js demo status
-node cli/dist/openwop.js catalog nodes --search ai
-node cli/dist/openwop.js runs create sample.demo.uppercase --input text=hello --wait
-node cli/dist/openwop.js packs search ads        # browse the signed pack registry
+openwop --help
+openwop doctor                 # check prerequisites
+openwop onboard                # guided setup (host + provider + key + model)
+openwop demo start             # boot local backend + frontend (from inside an openwop checkout)
+openwop demo status
+openwop catalog nodes --search ai
+openwop runs create sample.demo.uppercase --input text=hello --wait
+openwop packs search ads        # browse the signed pack registry
 ```
 
+> The `demo` subcommands operate on an [`openwop/openwop`](https://github.com/openwop/openwop) checkout discovered by walking up from your current directory; run them from inside a clone of that repo.
+
 ## Onboarding
 
 The `onboard` wizard walks you through:
@@ -153,6 +151,31 @@ openwop runs ancestry <runId>                             # RFC 0040 cross-host
 
 Beyond runs/workflows/catalog, the CLI surfaces the host's operator endpoints: `agents`, `memory`, `media`, `webhooks`, `chat`, plus `notifications` (inbox), `interrupts` (list/resolve human-in-the-loop pauses), and `prompts` (RFC 0029 library list/get/render). Every command supports `--json`.
 
+## Agent-platform surfaces
+
+These drive the demo app's protocol-enabled agent surfaces (each `--help` cites its RFC + endpoint):
+
+```bash
+openwop roster list                          # named standing agents + workflow portfolio (RFC 0086)
+openwop roster create --persona "Sally" --agent-ref core.x.agent --workflow sample.demo.triage
+openwop org-chart get                         # descriptive departments/reporting (RFC 0087)
+openwop org-chart set --file ./org.json       # replace the chart (departments[] + members[])
+openwop kanban boards                         # agent task boards
+openwop kanban board-create --name "Sally's work" --roster r_123
+openwop kanban card-add b_1 --title "Triage" --column todo
+openwop kanban watch b_1                       # stream a board's card events (SSE)
+openwop orgs list                             # organizations + RBAC (RFC 0049)
+openwop orgs teams|groups|roles|members <orgId> list|create|update|delete
+openwop orgs effective --subject user:jo      # resolve a subject's effective access
+openwop workspace list                        # per-tenant agent workspace files (RFC 0059)
+openwop workspace put notes/todo.md --content "- ship it"
+openwop byok list                             # BYOK credential refs (never values)
+openwop byok set --ref anthropic-prod         # prompts for the secret (no shell history)
+openwop agents create --persona "Triage bot" --model-class fast   # user-defined agent CRUD
+```
+
+Destructive commands (`roster delete`, `kanban board-delete`/`card-delete`, `orgs … delete`, `workspace delete`, `byok delete`, `agents delete`) require an explicit `--yes`.
+
 Two maintenance commands guard destructive operations behind a confirmation prompt (default *no*, bypass with `--confirm`):
 
 ```bash
@@ -195,3 +218,30 @@ Exit codes:
 - `2` — user-fixable error (unknown command, missing argument, 4xx response).
 
 The CLI is dependency-light by design. It uses Node built-ins so contributors can operate the demo app without installing another command framework.
+
+## Development
+
+This repo is a self-contained TypeScript package (the build is `esbuild`; it does not depend on the spec corpus). Requires Node ≥ 20.
+
+```bash
+npm ci
+npm run typecheck     # tsc --noEmit (strict, noImplicitAny)
+npm run build         # → dist/openwop.js (esbuild bundle)
+npm test              # build + node --test test/*.test.mjs
+node dist/openwop.js --help   # run the local build
+```
+
+CI (`.github/workflows/ci.yml`) runs typecheck + tests on every push and PR.
+
+## Releasing
+
+The package publishes to npm via an OIDC **trusted publisher** with provenance — no tokens in CI. Pushing a `vX.Y.Z` tag triggers `.github/workflows/publish.yml`, which builds, tests, and publishes `@openwop/cli@X.Y.Z` (idempotent: it skips if that version is already on npm).
+
+1. Bump `version` in `package.json` **and** `VERSION` in `src/constants.ts` (kept in lockstep), add a `CHANGELOG.md` entry.
+2. Commit (DCO-signed), then tag and push: `git tag vX.Y.Z && git push origin vX.Y.Z`.
+
+> **One-time setup (maintainer):** register this repo + `publish.yml` as the trusted publisher for `@openwop/cli` on npmjs.com (package → Settings → Trusted Publishers). The package was previously published from `openwop/openwop`; the binding must be repointed here before the first release.
+
+## Contributing
+
+Commits must be [DCO](https://developercertificate.org/) signed off (`git commit -s`). Follow [Conventional Commits](https://www.conventionalcommits.org/). Licensed under Apache-2.0 (see [`LICENSE`](./LICENSE)).