@gwdn/nexus-mcp 0.10.2 → 0.10.3
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/README.md +34 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -108,6 +108,40 @@ identity and enforces project-scoped RBAC.
|
|
|
108
108
|
|
|
109
109
|
## Development
|
|
110
110
|
|
|
111
|
+
### Recommended: Devbox
|
|
112
|
+
|
|
113
|
+
We recommend using [Devbox](https://www.jetify.com/devbox) to get a fully reproducible, isolated development environment with all required tools pre-installed (Node.js 22, git, ripgrep, tmux, lazygit, and more).
|
|
114
|
+
|
|
115
|
+
**Install Devbox** (once, system-wide):
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
curl -fsSL https://get.jetify.com/devbox | bash
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
**Enter the dev shell:**
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
devbox shell
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
This drops you into a Nix-managed shell with every tool pinned to the versions declared in `devbox.json`. No global installs, no version drift.
|
|
128
|
+
|
|
129
|
+
**Available Devbox scripts:**
|
|
130
|
+
|
|
131
|
+
| Script | Command | Description |
|
|
132
|
+
|--------|---------|-------------|
|
|
133
|
+
| `dev` | `devbox run dev` | Start MCP server via tsx (watch mode) |
|
|
134
|
+
| `build` | `devbox run build` | Compile TypeScript to `dist/` |
|
|
135
|
+
| `test` | `devbox run test` | Run full test suite |
|
|
136
|
+
| `typecheck` | `devbox run typecheck` | TypeScript type-check only |
|
|
137
|
+
| `validate` | `devbox run validate` | Full pre-commit validation (typecheck + tests) |
|
|
138
|
+
| `check-local` | `devbox run check-local` | Local environment health check |
|
|
139
|
+
| `sec-scan` | `devbox run sec-scan` | Security scan (gitleaks + audit) |
|
|
140
|
+
| `tmux-2w` | `devbox run tmux-2w` | Open 2-window tmux workspace |
|
|
141
|
+
| `tmux-3w` | `devbox run tmux-3w` | Open 3-window tmux workspace |
|
|
142
|
+
|
|
143
|
+
> **Without Devbox**, you can still run commands directly:
|
|
144
|
+
|
|
111
145
|
```bash
|
|
112
146
|
npm install
|
|
113
147
|
npm run typecheck # TypeScript check
|
package/package.json
CHANGED