@siteknock/cli 0.1.6

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.
Files changed (4) hide show
  1. package/README.md +70 -0
  2. package/cli.d.ts +1 -0
  3. package/cli.js +2223 -0
  4. package/package.json +23 -0
package/README.md ADDED
@@ -0,0 +1,70 @@
1
+ # @siteknock/cli
2
+
3
+ SiteKnock bootstrap CLI for licensed customer workspace setup.
4
+
5
+ ## Requirements
6
+
7
+ - Node.js 22+
8
+ - access to the SiteKnock package registry
9
+ - Docker installed if you plan to run `siteknock studio`
10
+
11
+ ## Install
12
+
13
+ ```bash
14
+ npm install -g @siteknock/cli
15
+ ```
16
+
17
+ This installs two commands: `siteknock` (primary) and `sk-cli` (backwards-compatible alias). Both are identical.
18
+
19
+ An unscoped `siteknock` wrapper is also available:
20
+
21
+ ```bash
22
+ npm install -g siteknock
23
+ ```
24
+
25
+ ## Commands
26
+
27
+ Show the SiteKnock CLI version banner and copyright line.
28
+
29
+ ```bash
30
+ siteknock --version
31
+ siteknock -v
32
+ ```
33
+
34
+ Verify registry access and fetch latest package metadata.
35
+
36
+ ```bash
37
+ siteknock probe
38
+ ```
39
+
40
+ Bootstrap a new customer workspace with initial configuration.
41
+
42
+ ```bash
43
+ siteknock create --project customer-app
44
+ ```
45
+
46
+ Start the SiteKnock Studio management interface (requires Docker).
47
+
48
+ ```bash
49
+ siteknock studio --project customer-app
50
+ ```
51
+
52
+ Validate workspace setup and verify all dependencies are correctly configured.
53
+
54
+ ```bash
55
+ siteknock verify --project customer-app
56
+ ```
57
+
58
+ ## Typical flow
59
+
60
+ ```bash
61
+ mkdir -p my-projects
62
+ cd my-projects
63
+
64
+ siteknock probe
65
+ siteknock create --project customer-a
66
+ siteknock verify --project customer-a
67
+ siteknock studio --project customer-a
68
+ ```
69
+
70
+ `siteknock` creates a base-folder `sk-cli.json` file that stores registered projects.
package/cli.d.ts ADDED
@@ -0,0 +1 @@
1
+ #!/usr/bin/env node