@mushi-mushi/cli 0.17.1 → 0.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +23 -1
- package/README.md +15 -1
- package/dist/chunk-ZB6ITDCQ.js +6 -0
- package/dist/index.js +2596 -2328
- package/dist/init.js +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/dist/chunk-XVLIMBPU.js +0 -6
package/CONTRIBUTING.md
CHANGED
|
@@ -63,7 +63,7 @@ packages/
|
|
|
63
63
|
verify/ Fix verification (BSL)
|
|
64
64
|
apps/
|
|
65
65
|
admin/ Admin dashboard (React + Tailwind)
|
|
66
|
-
docs/ Documentation site (
|
|
66
|
+
docs/ Documentation site (Nextra — apps/docs)
|
|
67
67
|
tooling/
|
|
68
68
|
eslint-config/ Shared ESLint flat config
|
|
69
69
|
tsconfig/ Shared TypeScript configs
|
|
@@ -81,6 +81,28 @@ tooling/
|
|
|
81
81
|
```
|
|
82
82
|
6. Open a pull request
|
|
83
83
|
|
|
84
|
+
### Documentation (docs-as-code)
|
|
85
|
+
|
|
86
|
+
If your PR changes **user-visible SDK or CLI behavior**, update docs in the **same PR**:
|
|
87
|
+
|
|
88
|
+
| Surface | When to update |
|
|
89
|
+
| --- | --- |
|
|
90
|
+
| `packages/*/README.md` | npm-facing install/API/config changes for that package |
|
|
91
|
+
| `apps/docs/content/**/*.mdx` | Long-form guides, quickstarts, admin console docs |
|
|
92
|
+
| Root `README.md` | Marketing stats only when counts change — run `pnpm check:docs-stats` |
|
|
93
|
+
|
|
94
|
+
Guardrails (run locally before pushing):
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
pnpm check:docs-stats # root README stat badges
|
|
98
|
+
pnpm check:sdk-version-matrix # apps/docs/content/sdks/index.mdx versions
|
|
99
|
+
pnpm check:internal-doc-links # dead /foo links in MDX
|
|
100
|
+
pnpm check:bundle-docs # @mushi-mushi/web size-limit vs README
|
|
101
|
+
pnpm gen:llms-txt # regenerate apps/docs/public/llms.txt after nav changes
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
README changes on npm packages only appear on [npmjs.com](https://www.npmjs.com) after the next **Changesets publish**.
|
|
105
|
+
|
|
84
106
|
## Changesets
|
|
85
107
|
|
|
86
108
|
We use [Changesets](https://github.com/changesets/changesets) for versioning. If your PR modifies a published package (`core`, `web`, `react`, `vue`, `svelte`, `angular`, `react-native`, `cli`, `mcp`), add a changeset:
|
package/README.md
CHANGED
|
@@ -100,6 +100,10 @@ Reads `package.json`, checks the npm registry for each installed
|
|
|
100
100
|
`@mushi-mushi/*` package, and runs the right install command for your package
|
|
101
101
|
manager (npm / pnpm / yarn / bun) to bump them to the latest stable release.
|
|
102
102
|
|
|
103
|
+
**Console equivalent:** **Connect & Update → Create Upgrade PR** opens a GitHub
|
|
104
|
+
draft PR for the linked repo (backed by `sdk-upgrade-worker`). Use the CLI for
|
|
105
|
+
local bumps; use the PR flow when you want review + CI on the dependency change.
|
|
106
|
+
|
|
103
107
|
```bash
|
|
104
108
|
mushi upgrade # plan + install
|
|
105
109
|
mushi upgrade --dry-run # print the install command without running it
|
|
@@ -302,6 +306,16 @@ mushi slack test
|
|
|
302
306
|
- The `--api-key` flag leaks into `ps -ef` — prefer the interactive prompt on shared machines.
|
|
303
307
|
- Full stack traces on error: `DEBUG=mushi mushi init`.
|
|
304
308
|
|
|
309
|
+
## Programmatic imports
|
|
310
|
+
|
|
311
|
+
The CLI is also importable for tooling (used by `create-mushi-mushi`):
|
|
312
|
+
|
|
313
|
+
| Subpath | Exports |
|
|
314
|
+
| --- | --- |
|
|
315
|
+
| `@mushi-mushi/cli/init` | `runInit`, `InitOptions` |
|
|
316
|
+
| `@mushi-mushi/cli/detect` | Framework / package-manager detection |
|
|
317
|
+
| `@mushi-mushi/cli/version` | `MUSHI_CLI_VERSION` |
|
|
318
|
+
|
|
305
319
|
## License
|
|
306
320
|
|
|
307
321
|
MIT
|
|
@@ -310,4 +324,4 @@ MIT
|
|
|
310
324
|
<!-- mushi-readme-stats-footer -->
|
|
311
325
|
---
|
|
312
326
|
|
|
313
|
-
<sub>Monorepo scale (June 2026):
|
|
327
|
+
<sub>Monorepo scale (June 2026): 47 edge functions · 256 SQL migrations · 13 outbound plugins · 11 inbound adapters · 18 pipeline agents. Canonical counts: <a href="https://github.com/kensaurus/mushi-mushi/blob/master/docs/stats.md">docs/stats.md</a> · <code>pnpm docs-stats</code></sub>
|