@zerwiz/ymir 0.1.2 → 0.1.4
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 +34 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,13 +14,24 @@
|
|
|
14
14
|
> One command stands it up on your own machine. No hosting, no accounts.
|
|
15
15
|
|
|
16
16
|
```bash
|
|
17
|
-
# curl
|
|
17
|
+
# 1 · curl — fetch the bootstrap and run it
|
|
18
18
|
curl -fsSL https://raw.githubusercontent.com/zerwiz/ymir-release/main/install.sh | bash
|
|
19
19
|
|
|
20
|
-
#
|
|
21
|
-
npx @zerwiz/ymir
|
|
20
|
+
# 2 · npx — no install, run once
|
|
21
|
+
npx @zerwiz/ymir # add --check (report only) or --yes (unattended)
|
|
22
|
+
|
|
23
|
+
# 3 · npm global — install the command, then run it
|
|
24
|
+
npm i -g @zerwiz/ymir
|
|
25
|
+
ymir
|
|
26
|
+
|
|
27
|
+
# 4 · clone the distro and run its installer directly
|
|
28
|
+
git clone https://github.com/zerwiz/ymir.git ~/.ymir
|
|
29
|
+
bash ~/.ymir/bin/ymir-install.sh
|
|
22
30
|
```
|
|
23
31
|
|
|
32
|
+
> All four run the **same installer**. It is idempotent — run it again and it heals
|
|
33
|
+
> forward. `--check` shows the plan without writing anything.
|
|
34
|
+
|
|
24
35
|
This npm package is only the **bootstrap** (install.sh + a thin `ymir` bin): it
|
|
25
36
|
fetches the Ymir distro and runs its installer, which provisions, self-heals and
|
|
26
37
|
**validates** what it claims is running. It carries no secrets.
|
|
@@ -28,6 +39,15 @@ fetches the Ymir distro and runs its installer, which provisions, self-heals and
|
|
|
28
39
|
> **Alpha** — the forge is hot and the anvil works, but expect rough edges, and do
|
|
29
40
|
> not expose it as a public service yet.
|
|
30
41
|
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
> **Who can install this today.** The Ymir distro is **private** while it is young —
|
|
46
|
+
> so `curl`, `npx` and `git clone` work for **the author and invited users**, not for
|
|
47
|
+
> the public (an unknown clone returns 404). If you would like access, ask:
|
|
48
|
+
> [zerwiz.org](https://zerwiz.org). When the distro opens, this note goes away and
|
|
49
|
+
> the four commands above become open to everyone.
|
|
50
|
+
|
|
31
51
|
---
|
|
32
52
|
|
|
33
53
|
# YMIR — The Single-Tenant Agent Operating System
|
|
@@ -550,6 +570,17 @@ the full day's ledger.
|
|
|
550
570
|
|
|
551
571
|
---
|
|
552
572
|
|
|
573
|
+
---
|
|
574
|
+
|
|
575
|
+
## Contributing
|
|
576
|
+
|
|
577
|
+
Ymir is a hobby project, and contributions are genuinely welcome — a bug report, a
|
|
578
|
+
docs fix, a new skill, a whole adapter. **Please fork, branch, and open a Pull
|
|
579
|
+
Request**: `main` is protected, so nothing lands without review. See
|
|
580
|
+
[CONTRIBUTING.md](CONTRIBUTING.md) for the whole of it.
|
|
581
|
+
|
|
582
|
+
*Be kind, keep it small, and name your subsystem true.*
|
|
583
|
+
|
|
553
584
|
## With gratitude — the people we stand on
|
|
554
585
|
|
|
555
586
|
Ymir is a Norse shell over other people's excellent work. We did not build the
|