agent-waybill 0.1.1__tar.gz

agent_waybill-0.1.1/INSTALL.md

@@ -0,0 +1,349 @@
+# Install Waybill
+
+Waybill ships as Markdown instructions for Claude Code, a local Codex plugin,
+OpenCode commands and skills, Cursor project rules, Gemini CLI workspace
+skills, and a small Python standard-library CLI. No package manager install is
+required.
+
+For the shortest setup path, start with `QUICKSTART.md`. This document keeps
+the fuller per-adapter details.
+
+## Codex
+
+This repository includes a repo-scoped plugin marketplace:
+
+```text
+.agents/plugins/marketplace.json
+```
+
+The marketplace exposes the Codex plugin at:
+
+```text
+adapters/codex/
+```
+
+To try it:
+
+1. Open this repository in Codex.
+2. Restart Codex if it was already running before this file existed.
+3. Add the repository marketplace:
+
+   ```bash
+   codex plugin marketplace add .
+   ```
+
+4. Install the plugin:
+
+   ```bash
+   codex plugin add waybill@waybill-local
+   ```
+
+5. Confirm it is installed:
+
+   ```bash
+   codex plugin list
+   ```
+
+   Expected status:
+
+   ```text
+   waybill@waybill-local  installed, enabled
+   ```
+
+6. Start a new Codex thread.
+7. Test the skill with:
+
+   ```text
+   /handoff import examples/claude-to-codex
+   ```
+
+The alias should behave the same way:
+
+```text
+/waybill import examples/claude-to-codex
+```
+
+Expected result: Codex reads the example bundle, checks the repository state,
+summarizes the original task, and identifies the next recommended step without
+applying `diff.patch`.
+
+## Codex Plugin Directory Alternative
+
+Instead of installing from the CLI, you can install from the plugin directory:
+
+1. Open the plugin directory:
+
+   ```text
+   /plugins
+   ```
+
+2. Select the `Waybill Local` marketplace.
+3. Install the `Waybill` plugin.
+4. Start a new thread and run the same import smoke test.
+
+## Claude Code
+
+This repository includes project-scoped Claude Code skills:
+
+```text
+.claude/skills/handoff/SKILL.md
+.claude/skills/waybill/SKILL.md
+```
+
+To try them:
+
+1. Open this repository in Claude Code:
+
+   ```bash
+   claude
+   ```
+
+2. Invoke the primary command:
+
+```text
+/handoff import examples/codex-to-claude
+```
+
+3. Invoke the alias:
+
+```text
+/waybill import examples/codex-to-claude
+```
+
+Expected result: Claude Code reads the example bundle, checks the repository
+state, summarizes the original task, and identifies the next recommended step
+without applying `diff.patch`.
+
+The older command instruction files are still provided in:
+
+```text
+adapters/claude-code/commands/
+```
+
+Use those files if your Claude Code setup still depends on `.claude/commands/`
+style custom commands instead of skills.
+
+## OpenCode
+
+This repository includes project-scoped OpenCode commands and skills:
+
+```text
+.opencode/commands/handoff.md
+.opencode/commands/waybill.md
+.opencode/skills/handoff/SKILL.md
+.opencode/skills/waybill/SKILL.md
+```
+
+To try them:
+
+1. Open this repository in OpenCode:
+
+   ```bash
+   opencode
+   ```
+
+2. Invoke the primary command:
+
+   ```text
+   /handoff import examples/claude-to-codex
+   ```
+
+3. Invoke the alias:
+
+   ```text
+   /waybill import examples/claude-to-codex
+   ```
+
+Expected result: OpenCode reads the example bundle, checks the repository
+state, summarizes the original task, and identifies the next recommended step
+without applying `diff.patch`.
+
+The reusable adapter files are available in:
+
+```text
+adapters/opencode/
+```
+
+## Cursor CLI
+
+This repository includes project-scoped Cursor rules:
+
+```text
+.cursor/rules/
+```
+
+To smoke test them with Cursor CLI in read-only ask mode:
+
+```bash
+agent -p --trust --mode=ask "handoff import examples/claude-to-codex. Do not modify files; only read the bundle, verify repository state, and summarize the handoff."
+```
+
+For scriptable output:
+
+```bash
+agent -p --trust --mode=ask --output-format json "handoff import examples/claude-to-codex. Do not modify files; only summarize."
+```
+
+Expected result: Cursor reads the example bundle, checks the repository state,
+summarizes the original task, and does not automatically apply `diff.patch`.
+
+Reusable adapter files are available in:
+
+```text
+adapters/cursor/
+```
+
+## Gemini CLI
+
+This repository includes project-scoped Gemini CLI skills:
+
+```text
+.gemini/skills/
+```
+
+To smoke test them in read-only plan mode:
+
+```bash
+gemini --skip-trust --approval-mode plan --model gemini-3.1-flash-lite -p "handoff import examples/claude-to-codex. Do not modify files; only read the bundle, verify repository state, and summarize the handoff."
+```
+
+For scriptable output:
+
+```bash
+gemini --skip-trust --approval-mode plan --model gemini-3.1-flash-lite --output-format json -p "handoff import examples/claude-to-codex. Do not modify files; only summarize."
+```
+
+Expected result: Gemini CLI reads the example bundle, checks the repository
+state, summarizes the original task, and does not automatically apply
+`diff.patch`.
+
+Reusable adapter files are available in:
+
+```text
+adapters/gemini-cli/
+```
+
+## Python Support Package
+
+The Python package provides the support CLI as a `waybill` command. It is useful
+for validation, inspection, redaction, packing, rendering, and adapter
+installation from outside a repository clone.
+
+The package does not replace the agent-native `/handoff` and `/waybill`
+commands. Those still come from the project adapter files installed into a
+target repository.
+
+After the package is published, install or run the support CLI with:
+
+```bash
+pipx install agent-waybill
+waybill --help
+```
+
+or:
+
+```bash
+uvx agent-waybill --help
+```
+
+## Smoke Test
+
+After installing the adapters you need, run the static repository validation:
+
+```bash
+python3 scripts/validate-waybill.py
+```
+
+Install Claude Code, OpenCode, Cursor, and Gemini CLI project files into another
+repository:
+
+```bash
+./cli/waybill init --target /path/to/repo
+./cli/waybill init --target /path/to/repo --json
+```
+
+Check the target repository installation:
+
+```bash
+./cli/waybill doctor --target /path/to/repo
+./cli/waybill doctor --target /path/to/repo --json
+```
+
+Create a draft bundle:
+
+```bash
+./cli/waybill new --output .waybill --repo .
+./cli/waybill new --output .waybill --repo . --json
+```
+
+Compare a bundle with the current repository state:
+
+```bash
+./cli/waybill verify-repo .waybill --repo .
+./cli/waybill verify-repo .waybill --repo . --json
+```
+
+Run the full import preflight check:
+
+```bash
+./cli/waybill preflight .waybill --repo .
+./cli/waybill preflight .waybill --repo . --json
+```
+
+Check whether a bundle is ready for handoff:
+
+```bash
+./cli/waybill ready .waybill --repo .
+./cli/waybill ready .waybill --repo . --json
+```
+
+Validate any generated bundle:
+
+```bash
+./cli/waybill validate .waybill
+./cli/waybill validate .waybill --json
+```
+
+Inspect bundle metadata and validation status:
+
+```bash
+./cli/waybill inspect .waybill
+./cli/waybill inspect .waybill --json
+```
+
+Create a redacted copy before sharing:
+
+```bash
+./cli/waybill redact .waybill --output .waybill-redacted
+./cli/waybill redact .waybill --output .waybill-redacted --json
+```
+
+Redact, validate, and pack a shareable archive:
+
+```bash
+./cli/waybill share .waybill --output waybill.zip
+./cli/waybill share .waybill --output waybill.zip --json
+```
+
+Pack a validated bundle into a zip archive:
+
+```bash
+./cli/waybill pack .waybill-redacted --output waybill.zip
+./cli/waybill pack .waybill-redacted --output waybill.zip --json
+```
+
+Unpack and validate a zip archive:
+
+```bash
+./cli/waybill unpack waybill.zip --output /tmp/waybill-unpacked
+./cli/waybill unpack waybill.zip --output /tmp/waybill-unpacked --json
+```
+
+Render a Markdown review report:
+
+```bash
+./cli/waybill render .waybill-redacted --output waybill-report.md
+./cli/waybill render .waybill-redacted --output waybill-report.md --json
+```
+
+Then follow the manual end-to-end test plan in `TESTING.md`.

agent_waybill-0.1.1/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.

agent_waybill-0.1.1/MANIFEST.in

@@ -0,0 +1,11 @@
+include README.md
+include LICENSE
+include QUICKSTART.md
+include INSTALL.md
+include TESTING.md
+recursive-include spec *.md *.json
+recursive-include examples *.md *.json *.patch *.log
+graft waybill_core/template-files
+prune .waybill
+prune .waybill-redacted
+prune .opencode/node_modules