@jiggai/recipes 0.2.25 → 0.3.1

package/LICENSE

@@ -0,0 +1,192 @@
+                                 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.
+
+      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

@@ -11,7 +11,7 @@ If you like durable workflows: ClawRecipes is built around a **file-first team w
 ## Quickstart
 ### 1) Install
 #### Option A (preferred): install from npm
-Once published:
+When published on npm:
 
 ```bash
 openclaw plugins install @jiggai/recipes
@@ -54,11 +54,22 @@ openclaw recipes dispatch \
   --owner lead
 ```
 
+## License
+
+ClawRecipes is licensed under **Apache-2.0**.
+
+Attribution requirement (practical): if you redistribute ClawRecipes (or a derivative work), you must retain the license and attribution notices (see `LICENSE` and `NOTICE`).
+
+Branding note: the license does not grant permission to use JIGGAI trademarks except as required for reasonable and customary attribution. See `TRADEMARK.md`.
+
+Contributions: we welcome PRs. By contributing, you agree that your contributions are licensed under the project’s Apache-2.0 license.
+
 ## Commands (high level)
 - `openclaw recipes list|show|status`
 - `openclaw recipes scaffold` (agent → `workspace-<agentId>` + writes workspace recipe `~/.openclaw/workspace/recipes/<agentId>.md` by default)
 - `openclaw recipes scaffold-team` (team → `workspace-<teamId>` + `roles/<role>/` + writes workspace recipe `~/.openclaw/workspace/recipes/<teamId>.md` by default)
-- `openclaw recipes install <idOrSlug> [--yes] [--global|--agent-id <id>|--team-id <id>]` (skills: global or scoped)
+- `openclaw recipes install-skill <idOrSlug> [--yes] [--global|--agent-id <id>|--team-id <id>]` (skills: global or scoped)
+- `openclaw recipes install <slug>` (marketplace recipe)
 - `openclaw recipes bind|unbind|bindings` (multi-agent routing)
 - `openclaw recipes dispatch ...` (request → inbox + ticket + assignment)
 - `openclaw recipes tickets|move-ticket|assign|take|handoff|complete` (file-first ticket workflow)
@@ -79,15 +90,26 @@ The plugin supports these config keys (with defaults):
 Config schema is defined in `openclaw.plugin.json`.
 
 ## Documentation
-Start here:
-- Installation: `docs/INSTALLATION.md`
-- Agents + skills: `docs/AGENTS_AND_SKILLS.md`
-- Tutorial (create a recipe): `docs/TUTORIAL_CREATE_RECIPE.md`
+**For users:**
+- [Installation](docs/INSTALLATION.md) — install the plugin
+- [Agents & skills](docs/AGENTS_AND_SKILLS.md) — mental model, tool policies
+- [Tutorial](docs/TUTORIAL_CREATE_RECIPE.md) — create your first recipe
+- [Commands](docs/COMMANDS.md) — full command reference
+- [Team workflow](docs/TEAM_WORKFLOW.md) — file-first workflow
+
+**For contributors:**
+- [Architecture](docs/ARCHITECTURE.md) — codebase structure
+- [Contributing](CONTRIBUTING.md) — setup, tests, PR workflow
 
 ## Development
 ### Unit tests (vitest)
 Run:
 - `npm test`
+- `npm run test:coverage` — coverage with CI thresholds (see `vitest.config.ts`)
+- `npm run smell-check` — quality checks (ESLint, jscpd, pattern grep)
+
+### Pre-commit hooks
+Husky runs on commit. Run `npm ci` first to install hooks.
 
 ### Scaffold smoke test (regression)
 A lightweight smoke check validates scaffold-team output contains the required testing workflow docs (ticket 0004).
@@ -98,6 +120,11 @@ Run:
 Notes:
 - Creates a temporary `workspace-smoke-<timestamp>-team` under `~/.openclaw/` and then deletes it.
 - Exits non-zero on mismatch.
+- Requires OpenClaw and workspace config.
+
+### For contributors
+- [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) — codebase structure
+- [CONTRIBUTING.md](CONTRIBUTING.md) — setup, commands, pre-commit, CI
 
 Reference:
 - Commands: `docs/COMMANDS.md`
@@ -139,8 +166,10 @@ Notes:
   - [Recipe format](https://github.com/JIGGAI/ClawRecipes/blob/main/docs/RECIPE_FORMAT.md): `docs/RECIPE_FORMAT.md`
   - [Team workflow](https://github.com/JIGGAI/ClawRecipes/blob/main/docs/TEAM_WORKFLOW.md): `docs/TEAM_WORKFLOW.md`
   - [Agents & Skills](https://github.com/JIGGAI/ClawRecipes/blob/main/docs/AGENTS_AND_SKILLS.md): `docs/AGENTS_AND_SKILLS.md`
+  - [Architecture](https://github.com/JIGGAI/ClawRecipes/blob/main/docs/ARCHITECTURE.md): `docs/ARCHITECTURE.md`
   - [Bundled](https://github.com/JIGGAI/ClawRecipes/blob/main/docs/BUNDLED_RECIPES.md): `docs/BUNDLED_RECIPES.md`
   - [Create Recipe Tutorial](https://github.com/JIGGAI/ClawRecipes/blob/main/docs/TUTORIAL_CREATE_RECIPE.md): `docs/TUTORIAL_CREATE_RECIPE.md`
+  - [Contributing](https://github.com/JIGGAI/ClawRecipes/blob/main/CONTRIBUTING.md): `CONTRIBUTING.md`
 
 ## Note
 ClawRecipes is meant to be *installed* and then used to build **agents + teams**.
@@ -149,3 +178,11 @@ Most users should focus on:
 - authoring recipes in their OpenClaw workspace (`<workspace>/recipes/*.md`)
 - scaffolding teams (`openclaw recipes scaffold-team ...`)
 - running the file-first workflow (dispatch → backlog → in-progress → testing → done)
+
+## Goals
+- Release Clawmarket, https://github.com/JIGGAI/ClawMarket, public url https://clawkitchen.ai
+- Release ClawKitchen, https://github.com/JIGGAI/ClawKitchen
+- Merge at least 1 community pull request
+- Daily shipping/pull requests of ClawRecipes features
+- Improve recipes with more detailed agent files
+- Add ability to install skills for agents through ClawKitchen

package/docs/AGENTS_AND_SKILLS.md

@@ -95,30 +95,26 @@ openclaw gateway restart
 
 > Tip: if you later re-run scaffold with `--apply-config`, the recipe’s tool policy may overwrite your manual edits. If you want a change to stick, encode it in the recipe.
 
-## Installing skills (workspace-local)
-ClawRecipes favors **workspace-local** installs so each OpenClaw workspace is self-contained.
+## Installing skills
+ClawRecipes favors **workspace-local** installs so each agent/team workspace is self-contained.
 
 ### Install a skill slug
 ```bash
-openclaw recipes install <skill-slug>
+openclaw recipes install-skill <skill-slug>
 # or non-interactive:
-openclaw recipes install <skill-slug> --yes
+openclaw recipes install-skill <skill-slug> --yes
 ```
 
-This runs ClawHub under the hood and installs into the **current OpenClaw workspace** skills dir:
-- `<workspace>/skills/<skill-slug>`
-
-Examples:
-- standalone agent workspace: `~/.openclaw/workspace-<agentId>/skills/<skill-slug>`
-- team workspace: `~/.openclaw/workspace-<teamId>/skills/<skill-slug>`
-
-> Note: in the new workspace policy, standalone agents live in `~/.openclaw/workspace-<agentId>` and teams live in `~/.openclaw/workspace-<teamId>`. Skill install targeting is still being refined during the experimental phase.
+By default, installs **globally** into `~/.openclaw/skills/`. Use flags to target a specific workspace:
+- `--global` — shared across all agents (default)
+- `--agent-id <id>` — `~/.openclaw/workspace-<agentId>/skills/<skill-slug>`
+- `--team-id <id>` — `~/.openclaw/workspace-<teamId>/skills/<skill-slug>`
 
 ### Install the skills required by a recipe
 If a recipe declares skills in `requiredSkills` or `optionalSkills`:
 
 ```bash
-openclaw recipes install <recipe-id>
+openclaw recipes install-skill <recipe-id>
 ```
 
 That installs the recipe’s declared skills.

package/docs/ARCHITECTURE.md

@@ -0,0 +1,109 @@
+# Architecture
+
+Overview of the ClawRecipes codebase for maintainers.
+
+## Overview
+
+`index.ts` acts as thin CLI wiring: it registers commands via `api.registerCli` and delegates to handlers. Business logic lives in `src/handlers/` and `src/lib/`. The plugin exports `__internal` for test-only access to handlers and lib functions.
+
+## File structure
+
+```
+ClawRecipes/
+├── index.ts                 # Entry point: CLI wiring, delegates to handlers
+├── src/
+│   ├── handlers/            # One file per command group
+│   │   ├── cron.ts          # Cron reconciliation (used during scaffold)
+│   │   ├── install.ts       # install-skill, install (marketplace recipe)
+│   │   ├── recipes.ts       # list, show, status, bind, unbind, bindings
+│   │   ├── scaffold.ts      # scaffold (single agent)
+│   │   ├── team.ts          # scaffold-team, migrate-team, remove-team
+│   │   └── tickets.ts       # tickets, move-ticket, assign, take, handoff, dispatch, complete
+│   └── lib/                 # Shared logic
+│       ├── recipes-config.ts # OpenClaw config load/write, bindings, agent snippets
+│       ├── recipes.ts       # Recipe listing, loading, workspace paths
+│       ├── recipe-id.ts     # Pick recipe id (auto-increment)
+│       ├── scaffold-utils.ts # Shared scaffold logic
+│       ├── ticket-workflow.ts # Ticket stages, move, assign, handoff
+│       ├── ticket-finder.ts  # Ticket lookup by id/number
+│       ├── lanes.ts         # Workflow stages (backlog, in-progress, testing, done)
+│       ├── cleanup-workspaces.ts
+│       ├── remove-team.ts   # Team uninstall logic
+│       └── ...              # prompt, template, skill-install, fs-utils, etc.
+├── recipes/                 # Bundled recipe markdown files
+├── scripts/                 # Smell-check, scaffold smoke, etc.
+└── tests/                   # Vitest unit tests
+```
+
+## Handler-to-command map
+
+| Handler   | Commands |
+|-----------|----------|
+| recipes   | list, show, status, bind, unbind, bindings |
+| scaffold  | scaffold |
+| team      | scaffold-team, migrate-team, remove-team |
+| tickets   | tickets, move-ticket, assign, take, handoff, dispatch, complete |
+| install   | install-skill (ClawHub skills), install (marketplace recipe), install-recipe (alias) |
+| cron      | Reconciled during scaffold (no standalone command) |
+
+## Shared scaffold flow
+
+Both `scaffold` and `scaffold-team` use:
+
+- `scaffoldAgentFromRecipe` — creates workspace, writes recipe-managed files, applies agent config
+- `reconcileRecipeCronJobs` — when a recipe declares `cronJobs`, installs/updates cron jobs per `cronInstallation` config
+
+Cron behavior applies to both commands when the recipe has `cronJobs` in frontmatter.
+
+## Data flow
+
+```mermaid
+flowchart LR
+    subgraph cli [CLI]
+        Cmd[recipes list/show/status/...]
+    end
+    subgraph idx [index.ts]
+        IndexTS[registerCli]
+    end
+    subgraph handlers [Handlers]
+        HRecipes[recipes.ts]
+        HScaffold[scaffold.ts]
+        HTeam[team.ts]
+        HTickets[tickets.ts]
+        HInstall[install.ts]
+    end
+    subgraph lib [Lib]
+        LibRecipes[recipes-config]
+        LibScaffold[scaffold-utils]
+        LibTickets[ticket-workflow]
+    end
+    Cmd --> IndexTS
+    IndexTS --> HRecipes
+    IndexTS --> HScaffold
+    IndexTS --> HTeam
+    IndexTS --> HTickets
+    IndexTS --> HInstall
+    HRecipes --> LibRecipes
+    HScaffold --> LibScaffold
+    HTeam --> LibScaffold
+    HTickets --> LibTickets
+```
+
+## Key decisions
+
+- **Tool policy preservation**: When a recipe omits `tools`, the scaffold preserves the existing agent's tool policy (rather than resetting it). See scaffold logic and tests.
+- **`__internal` export**: Unit tests import handlers and lib helpers via `__internal`; these are not part of the public plugin API.
+
+## Quality automation
+
+- **smell-check**: `npm run smell-check` runs:
+  - **ESLint**: `no-explicit-any`, `complexity`, `max-lines-per-function`, `max-params` (src/; index.ts exempt from complexity/lines)
+  - **jscpd**: Duplicate code detection (≥8 lines, ≥50 tokens)
+  - **Pattern grep**: `as any` in src/ (max 10), TODO/FIXME/XXX (max 20)
+- **lint**: `npm run lint` / `npm run lint:fix`
+- **tests**: `npm test` (vitest), `npm run test:coverage`
+- **CI**: `.github/workflows/ci.yml` runs test:coverage, smell-check, npm audit
+
+---
+
+If this doc is outdated, please submit a PR to update it.

package/docs/BUNDLED_RECIPES.md

@@ -19,8 +19,8 @@ openclaw recipes scaffold project-manager --agent-id pm --name "Project Manager"
 ```
 
 What it writes:
-- `agents/pm/SOUL.md`
-- `agents/pm/AGENTS.md`
+- `workspace-pm/SOUL.md`
+- `workspace-pm/AGENTS.md`
 
 Default tool policy (recipe-defined):
 - allows: `group:fs`, `group:web`, plus `cron` and `message`
@@ -272,18 +272,7 @@ openclaw recipes scaffold-team financial-planner-team --team-id financial-planne
 Roles:
 - lead, advisor, analyst, tax, insurance, ops
 
-## 17) `stock-trader-team` (team)
-**Use when:** you want a trading workflow: research/signals/risk/journaling.
-
-Scaffold:
-```bash
-openclaw recipes scaffold-team stock-trader-team --team-id stock-trader-team-team --apply-config
-```
-
-Roles:
-- lead, researcher, signals, risk, journal, ops
-
-## 18) `crypto-trader-team` (team)
+## 17) `crypto-trader-team` (team)
 **Use when:** you want a crypto trading workflow with onchain research.
 
 Scaffold: