@pasosdejesus/m 0.22.1 → 0.22.3

package/README.md

@@ -0,0 +1,57 @@
+# @pasosdejesus/m
+
+CLI and shared libraries to scaffold and manage integrated **Next.js + Hardhat**
+projects, the Pasos de Jesús way. Primary platform: **OpenBSD/adJ**; Linux
+(Ubuntu) is a secondary, supported platform.
+
+> *"Con sabiduría se edificó la casa, y con inteligencia se estableció"*
+> (Proverbios 24:3)
+
+## Install
+
+Create a project (no install needed):
+
+```bash
+npx -y @pasosdejesus/m m:create my-project "A description"
+```
+
+Or add it to an existing project; the CLI is shipped as `bin/m`:
+
+```bash
+pnpm add -D @pasosdejesus/m
+npx m --help
+```
+
+`@pasosdejesus/mpdj` is an optional plugin that adds the Pasos de Jesús
+extension (Christian alignment commands `ai:*`, requirements `req:*`,
+credentials). The `usdt` payment engine lives in `@pasosdejesus/usdt`.
+
+## What it gives you
+
+| Area | Commands |
+|------|----------|
+| Scaffolding | `m:create`, `m:update` |
+| Database (PostgreSQL + Kysely) | `db:create`, `db:migrate`, `db:rollback`, `db:dump`, `db:restore`, `db:structure:dump/load`, `db:check`, `db:console`, `db:test` |
+| Wallet (replaces `cast` on OpenBSD) | `wallet:generate`, `wallet:import`, `wallet:list`, `wallet:balance`, `wallet:send`, `wallet:approve`, `wallet:call`, `wallet:sign`, `wallet:broadcast`, `wallet:keccak`, `wallet:derive` — keys in `~/.m/wallets/` with `chmod 600` |
+| Contracts | `contract:test` (EVM via `@pasosdejesus/edr`, no native binaries) |
+| AI tooling | `ai:context`, `ai:readfile`, `ai:writefile`, `ai:edit`, `ai:grep`, `ai:glob` |
+| Requirements | `req:list`, `req:show`, `req:cross`, `req:compare`, `req:sync-from-repo`, `req:sync-to-repo`, `req:list-repo`, `req:create`, `req:close` |
+| Engines | `m:create engine`, `eng:list`, `eng:check`, `eng:wba:setup`, `eng:credentials:setup` |
+| Environment | `env:diff` |
+
+Subpath exports for programmatic use: `@pasosdejesus/m/i18n`,
+`/wba`, `/wba/routes`, `/debug`, `/test-utils`, `/blockchain/deployments`,
+`/e2e` and `/shadcn-components/ui/*`.
+
+## Documentation
+
+- Repository: <https://gitlab.com/pasosdeJesus/m>
+- `ARCHITECTURE.md` (design decisions and platform constraints), `API.md`
+  (full command and export reference), `CONTRIBUTING.md` (workflow and tests)
+  and `doc/` (feature guides) live in the repository.
+- Changes: `CHANGELOG.md` in the repository, also shipped as
+  `dist/CHANGELOG.md` in this package.
+
+## License
+
+ISC — see `LICENSE.md` (English) and `LICENCIA.md` (Spanish) in the repository.