@siteping/cli 0.3.0 → 0.4.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 ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 NeosiaNexus
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 ADDED
@@ -0,0 +1,70 @@
1
+ [![npm version](https://img.shields.io/npm/v/@siteping/cli)](https://www.npmjs.com/package/@siteping/cli)
2
+ [![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue)](https://www.typescriptlang.org/)
3
+
4
+ # @siteping/cli
5
+
6
+ CLI tool to set up [Siteping](https://github.com/NeosiaNexus/SitePing) in your project — scaffolds Prisma schema and API routes.
7
+
8
+ Part of the [@siteping](https://github.com/NeosiaNexus/SitePing) monorepo.
9
+
10
+ ## Usage
11
+
12
+ ```bash
13
+ npx @siteping/cli init
14
+ ```
15
+
16
+ ## Commands
17
+
18
+ | Command | Description |
19
+ |---------|-------------|
20
+ | `init` | Interactive setup: Prisma schema + API route generation |
21
+ | `sync` | Non-interactive Prisma schema sync (CI-friendly) |
22
+ | `status` | Diagnostic check of your Siteping integration |
23
+ | `doctor` | Test API endpoint connectivity |
24
+
25
+ ### `init`
26
+
27
+ Walks you through setting up Siteping:
28
+ 1. Detects your `prisma/schema.prisma`
29
+ 2. Merges `SitepingFeedback` and `SitepingAnnotation` models (idempotent)
30
+ 3. Generates the Next.js App Router API route
31
+
32
+ ```bash
33
+ npx @siteping/cli init
34
+ npx prisma db push
35
+ ```
36
+
37
+ ### `sync`
38
+
39
+ Non-interactive schema sync, useful for CI:
40
+
41
+ ```bash
42
+ npx @siteping/cli sync --schema prisma/schema.prisma
43
+ ```
44
+
45
+ ### `status`
46
+
47
+ Checks your integration:
48
+
49
+ ```bash
50
+ npx @siteping/cli status
51
+ ```
52
+
53
+ ### `doctor`
54
+
55
+ Tests API connectivity:
56
+
57
+ ```bash
58
+ npx @siteping/cli doctor --url http://localhost:3000
59
+ ```
60
+
61
+ ## Related Packages
62
+
63
+ | Package | Description |
64
+ |---------|-------------|
65
+ | [`@siteping/widget`](https://www.npmjs.com/package/@siteping/widget) | Browser feedback widget |
66
+ | [`@siteping/adapter-prisma`](https://www.npmjs.com/package/@siteping/adapter-prisma) | Server-side Prisma adapter |
67
+
68
+ ## License
69
+
70
+ [MIT](https://github.com/NeosiaNexus/SitePing/blob/main/LICENSE)