@wiimdy/openfunderse 0.1.0 → 0.1.2

package/README.md

@@ -2,6 +2,10 @@
 
 Install OpenFunderse skill packs into Codex.
 
+## Role
+- Monorepo distribution package for Codex skills/prompts/manifests.
+- Owns install UX (`npx @wiimdy/openfunderse@latest install openfunderse`) and pack copy logic.
+
 ## Usage
 
 ```bash
@@ -11,8 +15,39 @@ npx @wiimdy/openfunderse@latest list
 # install pack into ~/.codex/skills
 npx @wiimdy/openfunderse@latest install openfunderse
 
+# install strategy-only pack
+npx @wiimdy/openfunderse@latest install openfunderse-strategy
+
+# install participant-only pack
+npx @wiimdy/openfunderse@latest install openfunderse-participant
+
+# install pack + runtime package in one command (recommended)
+npx @wiimdy/openfunderse@latest install openfunderse --with-runtime
+
+# install pack + runtime + strategy env scaffold in one command
+npx @wiimdy/openfunderse@latest install openfunderse \
+  --with-runtime \
+  --env-profile strategy
+
 # install into custom codex home
 npx @wiimdy/openfunderse@latest install openfunderse --codex-home /custom/.codex
+
+# install runtime into a specific project directory
+npx @wiimdy/openfunderse@latest install openfunderse \
+  --with-runtime \
+  --runtime-dir /path/to/project
+
+# initialize bot env + fresh Monad wallet (strategy)
+npx @wiimdy/openfunderse@latest bot-init \
+  --skill-name strategy \
+  --env-path .env.strategy \
+  --yes
+
+# initialize participant bot env + wallet
+npx @wiimdy/openfunderse@latest bot-init \
+  --skill-name participant \
+  --env-path .env.participant \
+  --yes
 ```
 
 ## Notes
@@ -20,3 +55,23 @@ npx @wiimdy/openfunderse@latest install openfunderse --codex-home /custom/.codex
 - Skills are copied into `$CODEX_HOME/skills` (default `~/.codex/skills`).
 - Pack metadata/prompts are copied into `$CODEX_HOME/packs/<pack-name>`.
 - Use `--force` to overwrite existing installed skills.
+- `--with-runtime` installs `@wiimdy/openfunderse-agents` into the current project (`package.json` required).
+- Env scaffold generation is enabled by default (default path: `.env.openfunderse`).
+- `--env-profile` controls scaffold scope: `strategy` | `participant` | `all` (auto-selected by pack when omitted).
+- Use `--no-init-env` to skip env scaffold generation.
+- `--env-path` sets a custom env scaffold path.
+- Optional: `--runtime-package`, `--runtime-dir`, `--runtime-manager`.
+- Available packs: `openfunderse` (unified), `openfunderse-strategy`, `openfunderse-participant`.
+- Split packs (`openfunderse-strategy`, `openfunderse-participant`) are intentionally minimal and centered on the skill payload.
+- Prefer `--env-path` (Node 20+ reserves `--env-file` as a runtime flag).
+- `bot-init` uses `cast wallet new --json` (Foundry) to generate a new wallet for Monad testnet.
+- `bot-init` infers role from `--skill-name`, `--env-path`, or `--wallet-name` when `--role` is omitted.
+- It also infers from active skill env hints (`OPENCLAW_SKILL_KEY`, `OPENCLAW_ACTIVE_SKILL`, `SKILL_KEY`, `SKILL_NAME`).
+- `bot-init` writes role-specific key fields:
+  - `strategy`: `STRATEGY_PRIVATE_KEY`, `BOT_ADDRESS`
+  - `participant`: `PARTICIPANT_PRIVATE_KEY`, `PARTICIPANT_BOT_ADDRESS`, `BOT_ADDRESS`
+- `bot-init` stores a wallet backup JSON under `$CODEX_HOME/openfunderse/wallets`.
+- Generated scaffolds include a temporary bootstrap key value. It is public/unsafe and must be rotated via `bot-init` before funding.
+- `bot-init` shows a warning and requires confirmation (`Type YES`) unless `--yes` is passed.
+- If private key already exists in the target env file, `bot-init` requires `--force` to rotate.
+- CLI cannot mutate your parent shell env directly; run the printed `set -a; source ...; set +a` command.