@uniac/cli 0.2.2 → 0.3.0

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 (2) hide show
  1. package/README.md +33 -0
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -14,6 +14,35 @@ Or run without installing:
14
14
  npx -y @uniac/cli version
15
15
  ```
16
16
 
17
+ ## Quickstart
18
+
19
+ A project is a directory with a `uniac.yaml` describing its services
20
+ and deployments as static resources:
21
+
22
+ ```yaml
23
+ runtime: yaml
24
+ default: shop
25
+ resources:
26
+ worker:
27
+ type: service
28
+ image: "mendhak/http-https-echo:31"
29
+ public_ports: [8080]
30
+ env: { GREETING: hello }
31
+ shop:
32
+ type: deployment
33
+ services:
34
+ workera: { from: worker }
35
+ ```
36
+
37
+ ```bash
38
+ uniac init # scaffold uniac.yaml
39
+ uniac plan # resolve + preview the deployable (no network)
40
+ uniac deploy # ship it (links the project on first run)
41
+ ```
42
+
43
+ Full manifest reference:
44
+ [docs/uniac-yaml.md](https://github.com/uniac-ai/Uniac/blob/main/docs/uniac-yaml.md).
45
+
17
46
  ## How it works
18
47
 
19
48
  `@uniac/cli` is a tiny JS shim plus one `optionalDependencies` entry
@@ -44,6 +73,10 @@ This directory is the staging template; the published copies live only
44
73
  under the gitignored `platform-packages/`. See
45
74
  [`../go/README.md`](../go/README.md) for the full release runbook.
46
75
 
76
+ To deprecate (or un-deprecate) a published version, dispatch
77
+ `.github/workflows/npm-deprecate.yml` — the npm token lives only in
78
+ CI.
79
+
47
80
  ## License
48
81
 
49
82
  MIT. See [LICENSE](./LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniac/cli",
3
- "version": "0.2.2",
3
+ "version": "0.3.0",
4
4
  "type": "module",
5
5
  "description": "Control-plane CLI for Uniac services",
6
6
  "bin": {
@@ -23,9 +23,9 @@
23
23
  },
24
24
  "homepage": "https://uniac.ai",
25
25
  "optionalDependencies": {
26
- "@uniac/cli-darwin-arm64": "0.2.2",
27
- "@uniac/cli-darwin-x64": "0.2.2",
28
- "@uniac/cli-linux-arm64": "0.2.2",
29
- "@uniac/cli-linux-x64": "0.2.2"
26
+ "@uniac/cli-darwin-arm64": "0.3.0",
27
+ "@uniac/cli-darwin-x64": "0.3.0",
28
+ "@uniac/cli-linux-arm64": "0.3.0",
29
+ "@uniac/cli-linux-x64": "0.3.0"
30
30
  }
31
31
  }