@ariestools/cli 0.1.6

package/dist/plugins/xy-readme/skills/readme-init/SKILL.md

@@ -0,0 +1,243 @@
+---
+name: readme-init
+description: Bootstrap a brand-new package README from scratch in the xylabs / xyo style. Reads package.json for name and description, detects the package tier, and emits a complete README.md ready for the user to fill in About / What's Inside content. Use when adding a new package and there is no README.md yet.
+---
+
+# README Init (xylabs / xyo convention)
+
+This skill creates a fresh `README.md` for a package that doesn't have one
+yet. It is the bootstrap counterpart to `readme-author` — the latter
+*authors and updates* an existing or partially-written README; this skill
+*creates one from scratch*.
+
+## When to use
+
+- Adding a new package to a monorepo that has no `README.md`.
+- Replacing a placeholder/empty README with the full template.
+
+If a `README.md` already exists with non-trivial content, route the work to
+the `readme-author` skill instead — don't overwrite hand-written content.
+
+## Inputs
+
+Run from the package directory (the one containing `package.json`).
+
+Read the following from `package.json`:
+
+- `name` — the full package name (e.g. `@xyo-network/xl1-blockies`).
+- `description` — used as the tagline; if missing, prompt the user for one
+  before continuing.
+- `exports` — used to detect whether the package has subpath exports.
+- `dependencies` / `peerDependencies` — used for tier detection and to
+  decide whether to include a "Peer Dependencies" section.
+
+## Tier detection (heuristic)
+
+Inspect `package.json` and the source layout:
+
+- **Aggregate** — most or all `dependencies` are `workspace:*` siblings;
+  `src/` is mostly re-exports (a single `index.ts` re-exporting from siblings,
+  or only a small surface of glue code). Use the aggregate template.
+- **Mid-tier** — substantial `src/` with multiple modules; may have multiple
+  `exports` entries. Use the mid-tier template.
+- **Leaf** — small, single-purpose; one or a few source files; few
+  dependencies. Use the leaf template.
+
+When unsure between mid-tier and leaf, prefer mid-tier (the resulting README
+just has more sections; the user can prune).
+
+## Steps
+
+1. **Verify there is no existing README.** If `README.md` exists and has
+   more than a few placeholder lines, stop and ask the user what to do.
+2. **Read `package.json`.** Extract `name`, `description`, `exports`,
+   `dependencies`, `peerDependencies`.
+3. **Determine tier** using the heuristic above.
+4. **Pick a template** below and substitute `{{NAME}}` and `{{TAGLINE}}`
+   throughout. For aggregate packages, also fill in the description and
+   component package list.
+5. **Leave hand-written sections as TODO placeholders.** "About" /
+   "Description" and "What's Inside" content cannot be derived from
+   `package.json`; emit them as HTML comments the user fills in:
+
+   ```markdown
+   ## About
+
+   <!-- TODO: 1–3 paragraphs explaining what this package is, how it
+        relates to its umbrella aggregate, and when to install it directly
+        vs. via the aggregate. -->
+   ```
+
+6. **Always include the verbatim Maintainers table, License, and Credits
+   sections** from the `readme-author` skill.
+7. **Verify reference links resolve** by reminding the user that the npm
+   badge will only render once the package is published. The license badge
+   uses the package name's npm shield endpoint; if the package isn't on npm
+   yet, the badge will render as "n/a" until publish.
+
+## Templates
+
+### Leaf
+
+Use when the package is small and single-purpose.
+
+````markdown
+[![logo][]][logo-link]
+
+# {{NAME}}
+
+[![npm-badge][]][npm-link]
+[![license-badge][]][license-link]
+
+> {{TAGLINE}}
+
+## About
+
+<!-- TODO: 1–2 paragraphs explaining what this package is and when to use it. -->
+
+## Install
+
+Using npm:
+
+```sh
+npm i --save {{NAME}}
+```
+
+Using yarn:
+
+```sh
+yarn add {{NAME}}
+```
+
+Using pnpm:
+
+```sh
+pnpm add {{NAME}}
+```
+
+Using bun:
+
+```sh
+bun add {{NAME}}
+```
+
+## What's Inside
+
+<!-- TODO: bullet list of public surface (components, functions, types). -->
+
+## Building Locally
+
+```sh
+xy build {{NAME}}
+xy test {{NAME}}
+xy lint {{NAME}}
+```
+
+## Maintainers
+
+<table>
+  <tr>
+    <td align="center" valign="top" width="120">
+      <a href="https://github.com/arietrouw">
+        <img src="https://github.com/arietrouw.png" width="80" height="80" alt="Arie Trouw" /><br />
+        <sub><b>Arie Trouw</b></sub>
+      </a>
+      <br />
+      <a href="https://arietrouw.com">arietrouw.com</a>
+    </td>
+    <td align="center" valign="top" width="120">
+      <a href="https://github.com/jonesmac">
+        <img src="https://github.com/jonesmac.png" width="80" height="80" alt="Matt Jones" /><br />
+        <sub><b>Matt Jones</b></sub>
+      </a>
+    </td>
+    <td align="center" valign="top" width="120">
+      <a href="https://github.com/JoelBCarter">
+        <img src="https://github.com/JoelBCarter.png" width="80" height="80" alt="Joel Carter" /><br />
+        <sub><b>Joel Carter</b></sub>
+      </a>
+    </td>
+  </tr>
+</table>
+
+## License
+
+See the [LICENSE](./LICENSE) file (LGPL-3.0-only).
+
+## Credits
+
+[Made with 🔥 and ❄️ by XYO](https://xyo.network)
+
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo-link]: https://xyo.network
+
+[npm-badge]: https://img.shields.io/npm/v/{{NAME}}.svg
+[npm-link]: https://www.npmjs.com/package/{{NAME}}
+
+[license-badge]: https://img.shields.io/npm/l/{{NAME}}.svg
+[license-link]: ./LICENSE
+````
+
+### Mid-tier
+
+Like the leaf template, plus a Subpath Exports section if `package.json#exports`
+has more than one entry. Insert this section between Install and What's Inside:
+
+```markdown
+## Subpath Exports
+
+<!-- TODO: list each entry from package.json#exports with a one-line
+     reason for why it's a separate subpath. -->
+
+- `{{NAME}}` — main barrel
+```
+
+### Aggregate
+
+Use the leaf template as the base, and:
+
+1. Insert a Table of Contents after the tagline:
+
+   ```markdown
+   ## Table of Contents
+
+   - [Description](#description)
+   - [Install](#install)
+   - [What's Inside](#whats-inside)
+   - [Building Locally](#building-locally)
+   - [Maintainers](#maintainers)
+   - [License](#license)
+   - [Credits](#credits)
+   ```
+
+2. Replace `## About` with `## Description`.
+3. In the Description placeholder, list the workspace siblings this package
+   re-exports as bullets, each linking to its npm page.
+4. Optional: replace the leaf-style "Building Locally" with the unscoped
+   form used in aggregate-root READMEs:
+
+   ````markdown
+   ## Building Locally
+
+   From the repo root:
+
+   ```sh
+   xy build      # compile + publint + deplint + lint
+   xy test       # vitest
+   xy lint       # eslint
+   ```
+
+   Scope to this package: `xy build {{NAME}}`.
+   ````
+
+## Output
+
+Write the assembled file to `./README.md` in the package directory. Then
+remind the user:
+
+- Hand-written sections (`## About` / `## Description`, `## What's Inside`,
+  `## Subpath Exports` if applicable) are TODOs to fill in.
+- The Maintainers table is a default — edit it if the maintainers list
+  differs.
+- Run the `readme-audit` skill once you've filled in the TODOs to verify
+  alignment with the convention.

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@ariestools/cli",
+  "version": "0.1.6",
+  "description": "Aries Tools CLI - A suite of tools by Arie Trouw",
+  "keywords": [
+    "ariestools",
+    "cli",
+    "typescript"
+  ],
+  "homepage": "https://ariestools.ai",
+  "license": "UNLICENSED",
+  "author": {
+    "name": "Arie Trouw",
+    "email": "support@ariestools.ai",
+    "url": "https://ariestools.ai"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "bin": {
+    "aries": "dist/bin/aries.mjs"
+  },
+  "files": [
+    "dist/bin",
+    "dist/plugins",
+    "README.md"
+  ],
+  "dependencies": {
+    "@opentelemetry/api": "~1.9.1",
+    "@xyo-network/sdk-protocol": "~7.2.1",
+    "async-mutex": "~0.5.0",
+    "ethers": "~6.17.0",
+    "imghash": "~1.1.4",
+    "lmdb": "~3.5.6",
+    "pdq-wasm": "~0.3.9",
+    "sharp": "~0.35.3",
+    "sharp-phash": "~2.2.0",
+    "zod": "~4.4.3",
+    "@ariestools/aries-chain-serve": "~0.1.6",
+    "@xyo-network/wallet-xl1-cli": "~0.1.6"
+  },
+  "devDependencies": {
+    "@ariestools/sdk": "~8.1.1",
+    "@ariestools/toolchain": "~8.7.15",
+    "@ariestools/tsconfig": "~8.7.15",
+    "@metamask/json-rpc-engine": "~10.5.0",
+    "@opentelemetry/sdk-trace-base": "~2.9.0",
+    "@types/node": "~26.1.1",
+    "@xyo-network/sdk": "~7.2.1",
+    "@xyo-network/xl1-sdk": "~4.4.7",
+    "eslint": "~10.7.0",
+    "rolldown": "~1.2.0",
+    "tsx": "~4.23.1",
+    "typescript": "~6.0.3",
+    "vite": "~8.1.4",
+    "vitest": "~4.1.10",
+    "web3-types": "~1.10.0",
+    "yargs": "~18.0.0",
+    "@ariestools/cli-lib": "~0.1.6"
+  },
+  "engines": {
+    "node": ">=18.17.1"
+  },
+  "engineStrict": true,
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "package-clean": "rm -rf dist bundle",
+    "package-compile": "tsc -p tsconfig.build.json --noEmit && rolldown -c rolldown.config.ts && tsx scripts/buildBundle.ts"
+  }
+}