hkcc 0.1.0 → 0.1.2
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 +10 -5
- package/dist/hkcc.js +319 -372
- package/dist/index.js +123 -176
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -38,6 +38,9 @@ graph LR
|
|
|
38
38
|
|
|
39
39
|
**Multi-User Support:** Session cookies and per-user API keys with database-backed credential storage
|
|
40
40
|
|
|
41
|
+
> **⚠️ Runtime Requirement**
|
|
42
|
+
> This package **MUST be run with Bun** (>=1.0.0). It uses `bun:sqlite` under the hood for the database layer, which is not compatible with Node.js.
|
|
43
|
+
|
|
41
44
|
See [TECHNICAL.md](TECHNICAL.md) for detailed architecture diagrams and implementation details.
|
|
42
45
|
|
|
43
46
|
## Quick Start
|
|
@@ -80,13 +83,15 @@ HKCC can be run as a CLI tool via `npx` or `bunx`, perfect for quick local usage
|
|
|
80
83
|
|
|
81
84
|
### Installation
|
|
82
85
|
|
|
83
|
-
|
|
84
|
-
# Via npx (requires Node.js)
|
|
85
|
-
npx hkcc --help
|
|
86
|
+
> **⚠️ Bun Required**: Even when using `npx`, Bun must be installed on your system because the bundled CLI uses `bun:sqlite` internally.
|
|
86
87
|
|
|
87
|
-
|
|
88
|
+
```bash
|
|
89
|
+
# Via bunx (recommended - uses Bun directly)
|
|
88
90
|
bunx hkcc --help
|
|
89
91
|
|
|
92
|
+
# Via npx (Bun must be installed on system)
|
|
93
|
+
npx hkcc --help
|
|
94
|
+
|
|
90
95
|
# Or run directly from the repo
|
|
91
96
|
bun run bin/hkcc.ts --help
|
|
92
97
|
```
|
|
@@ -730,7 +735,7 @@ See [TECHNICAL.md](./TECHNICAL.md) for architecture details.
|
|
|
730
735
|
|
|
731
736
|
## Tech Stack
|
|
732
737
|
|
|
733
|
-
- **Runtime**: Bun
|
|
738
|
+
- **Runtime**: Bun (>=1.0.0) - **Required** (uses `bun:sqlite`)
|
|
734
739
|
- **Framework**: Elysia
|
|
735
740
|
- **Frontend**: React, TanStack Router, Tailwind CSS
|
|
736
741
|
- **Type-Safe Client**: Eden
|