@quickback-dev/cli 0.9.5 → 0.10.1
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/LICENSE +21 -0
- package/README.md +104 -1
- package/dist/docs/content.d.ts.map +1 -1
- package/dist/docs/content.js +35 -30
- package/dist/docs/content.js.map +1 -1
- package/dist/examples/recruitment.tar.gz +0 -0
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +43 -17
- package/src/examples/recruitment.tar.gz +0 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Kardoe Incorporated
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,7 +1,110 @@
|
|
|
1
1
|
# @quickback-dev/cli
|
|
2
2
|
|
|
3
|
-
CLI for the Quickback compiler.
|
|
3
|
+
The Quickback CLI — a thin client for the Quickback compiler. Define your backend in TypeScript, run `quickback compile`, and ship a fully wired Cloudflare Worker (or Bun / Node) project with auth, database, migrations, security pillars, CMS, and Account UI already generated.
|
|
4
4
|
|
|
5
|
+
```bash
|
|
6
|
+
npm i -g @quickback-dev/cli
|
|
7
|
+
quickback create cloudflare my-app
|
|
8
|
+
cd my-app
|
|
9
|
+
quickback compile
|
|
10
|
+
```
|
|
5
11
|
|
|
12
|
+
Full docs: [docs.quickback.dev](https://docs.quickback.dev)
|
|
6
13
|
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Commands
|
|
17
|
+
|
|
18
|
+
| Command | What it does |
|
|
19
|
+
|---|---|
|
|
20
|
+
| `quickback create <template> <name>` | Scaffold a new project from a Quickback template (e.g. `cloudflare`, `bun`, `nextjs`) |
|
|
21
|
+
| `quickback compile` | Compile your `quickback/quickback.config.ts` + feature definitions into a generated project. Writes `src/`, `wrangler.toml`, `quickback/drizzle/...`, etc. |
|
|
22
|
+
| `quickback example [name]` | Extract a pre-compiled example project (e.g. `recruitment`) into the current directory |
|
|
23
|
+
| `quickback init` | Initialize the `quickback/` folder structure in an existing project |
|
|
24
|
+
| `quickback login` | Authenticate against `api.quickback.dev` (device flow, opens browser) |
|
|
25
|
+
| `quickback logout` | Clear stored credentials |
|
|
26
|
+
| `quickback whoami` | Show the currently authenticated account |
|
|
27
|
+
| `quickback mcp` | Start a stdio MCP server exposing Quickback docs to AI tools (Claude Desktop, Cursor, etc.) |
|
|
28
|
+
| `quickback claude` / `cursor` | Install Quickback's bundled skill / rules into Claude Code or Cursor |
|
|
29
|
+
|
|
30
|
+
## Project layout
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
my-app/
|
|
34
|
+
├── quickback/
|
|
35
|
+
│ ├── quickback.config.ts # providers (cloudflare-d1, better-auth, …), CMS, account, etc.
|
|
36
|
+
│ ├── definitions/
|
|
37
|
+
│ │ ├── features/<table>/ # schema.ts (Drizzle), resource config (firewall/access/guards/masking)
|
|
38
|
+
│ │ └── services/ # queues, realtime, embeddings
|
|
39
|
+
│ └── drizzle/ # migration SQL + meta (compiler-owned, commit this)
|
|
40
|
+
├── src/ # generated runtime — overwritten on every compile
|
|
41
|
+
├── wrangler.toml # generated
|
|
42
|
+
└── package.json
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Configuration
|
|
46
|
+
|
|
47
|
+
| Env var | Purpose | Default |
|
|
48
|
+
|---|---|---|
|
|
49
|
+
| `QUICKBACK_API_URL` | Compiler endpoint | `https://compiler.quickback.dev` |
|
|
50
|
+
| `QUICKBACK_API_KEY` | Skip device-flow login (CI) | — |
|
|
51
|
+
|
|
52
|
+
## Requirements
|
|
53
|
+
|
|
54
|
+
- Node.js ≥ 18
|
|
55
|
+
- `wrangler` (peer requirement only when deploying the generated Cloudflare Worker)
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## Security & Supply Chain
|
|
60
|
+
|
|
61
|
+
If you're using a supply-chain scanner (Socket, Snyk, Sonatype, etc.) you may see findings on this package. We're a small team that takes security seriously — here's what each finding actually is, and why it's there.
|
|
62
|
+
|
|
63
|
+
### "Network access" (8 transitive packages)
|
|
64
|
+
|
|
65
|
+
The CLI itself makes exactly **two** outbound requests, both to our own subdomains and both gated behind environment-variable overrides:
|
|
66
|
+
|
|
67
|
+
- `https://compiler.quickback.dev` — the compile API (`POST /compile`, `GET /templates`, `GET /health`). Source: [`src/lib/api-client.ts`](./src/lib/api-client.ts).
|
|
68
|
+
- `https://api.quickback.dev` — auth/device-flow login. Source: [`src/commands/login.ts`](./src/commands/login.ts).
|
|
69
|
+
|
|
70
|
+
The other 6 transitive packages flagged here (`eventsource`, `eventsource-parser`, `jose`, `pkce-challenge`, `body-parser`, `proxy-addr`) come from the optional MCP SDK transports — see *MCP SDK*, below.
|
|
71
|
+
|
|
72
|
+
### "Shell access" (2 packages)
|
|
73
|
+
|
|
74
|
+
`cross-spawn` and `which`/`isexe`, both transitive of `@modelcontextprotocol/sdk`. The CLI's own shell-out is in [`src/lib/shell.ts`](./src/lib/shell.ts) — used to run post-compile commands the compiler returns (e.g. `drizzle-kit generate`, `npm install`). Commands are not user-input-derived; they come from the trusted compile API response and run in your project directory.
|
|
75
|
+
|
|
76
|
+
### "Install scripts" (1 package)
|
|
77
|
+
|
|
78
|
+
`esbuild`. esbuild ships a platform-specific native binary that's downloaded by its install script. We use esbuild to parse your `quickback.config.ts` and feature definitions — it's a hard requirement of the CLI. esbuild is one of the most-downloaded packages on npm and is published by the Vercel team.
|
|
79
|
+
|
|
80
|
+
### "Uses eval" (5 transitive packages)
|
|
81
|
+
|
|
82
|
+
`ajv`, `kleur`, `qs`, `pkce-challenge`, and one more — none authored by us, none invoked from CLI code. `ajv` (JSON schema) compiles validators via `new Function()`, which scanners flag as eval-equivalent. All are transitive of `@modelcontextprotocol/sdk`.
|
|
83
|
+
|
|
84
|
+
### "AI-detected possible typosquat: parseuri"
|
|
85
|
+
|
|
86
|
+
False positive. The flagged package is [`parseurl`](https://www.npmjs.com/package/parseurl) — a 12-year-old Express middleware (~50M weekly downloads), pulled in via the MCP SDK's HTTP transport. Not a typosquat of `parseuri`; the names just rhyme.
|
|
87
|
+
|
|
88
|
+
### Why MCP SDK is a hard dependency
|
|
89
|
+
|
|
90
|
+
`@modelcontextprotocol/sdk` powers the `quickback mcp` command — a stdio MCP server that lets Claude Desktop / Cursor / Windsurf read Quickback's documentation as context. We made it a hard dep (rather than a peer dep) so that `quickback mcp` Just Works after a single `npm i -g`, no second install step. The SDK is loaded via dynamic `import()`, so its code never executes unless you actually run `quickback mcp`.
|
|
91
|
+
|
|
92
|
+
The trade-off: even users who never run `mcp` get its transitive packages in their install tree. We think the UX win is worth it; if you're scanning aggressively and would rather we move it to optional peers, [open an issue](https://github.com/paulstenhouse/quickback-compiler/issues).
|
|
93
|
+
|
|
94
|
+
### URL strings in the bundle
|
|
95
|
+
|
|
96
|
+
Most of the URLs Socket finds are inside `src/docs/content.ts` (a JSON dump of the marketing docs we ship for the `quickback help` and `quickback mcp` commands) and `src/skill/SKILL.md` (the Claude Code skill). They're documentation references — never fetched by the CLI.
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## License
|
|
101
|
+
|
|
102
|
+
MIT © Kardoe Incorporated
|
|
103
|
+
|
|
104
|
+
## Links
|
|
105
|
+
|
|
106
|
+
- [Quickback compiler docs](https://docs.quickback.dev)
|
|
107
|
+
- [GitHub repository](https://github.com/paulstenhouse/quickback-compiler)
|
|
108
|
+
- [Issue tracker](https://github.com/paulstenhouse/quickback-compiler/issues)
|
|
109
|
+
- [Changelog](https://docs.quickback.dev/compiler/changelog)
|
|
7
110
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"content.d.ts","sourceRoot":"","sources":["../../src/docs/content.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,eAAO,MAAM,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,
|
|
1
|
+
{"version":3,"file":"content.d.ts","sourceRoot":"","sources":["../../src/docs/content.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,eAAO,MAAM,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CA6czC,CAAC;AAEF,eAAO,MAAM,UAAU,UAoHtB,CAAC"}
|