96 lines
3.2 KiB
Markdown
Executable File
96 lines
3.2 KiB
Markdown
Executable File
# Sorcery-Go Quick Start
|
|
|
|
## 1. Bootstrap
|
|
|
|
```bash
|
|
./scripts/bootstrap.sh
|
|
make build
|
|
sudo make caps
|
|
./build/sorcery init
|
|
```
|
|
|
|
## 2. The Primary Rituals
|
|
|
|
| Ritual | Command | Effect |
|
|
|----------|--------------------------------------|-------------------------------------|
|
|
| Cast | `sorcery cast <spell>` | Forge an Essence in the Cauldron |
|
|
| Reanimate| `sorcery reanimate <ess> --sanctum <id>` | Deploy an Essence from the Tomb |
|
|
| Gaze | `sorcery gaze install <spell>` | Inspect every file owned by an Essence |
|
|
| Ward | `sorcery ward status` | Check firewall and alarm status |
|
|
| Banish | `sorcery dispel <spell>` | Surgical removal from a Sanctum |
|
|
|
|
## 3. Cast Flags
|
|
|
|
| Flag | Effect |
|
|
|-------------------------|----------------------------------------------|
|
|
| `--target <arch>` | Cross-compile for x86_64, aarch64, or any BTC target |
|
|
| `--static` | Produce a portable static ELF (musl) |
|
|
| `-r` / `--reconfigure` | Force ICE y/n prompts even if Tablet has answers |
|
|
| `-d` / `--default` | Accept all defaults (HPC-friendly) |
|
|
| `-m` / `--matrix` | Build across all maintained arches simultaneously |
|
|
|
|
## 4. Coven Management
|
|
|
|
```bash
|
|
sorcery coven join <master-ip> # Add a new Sanctum to the Coven
|
|
sorcery coven pulse # Live heartbeat of every node
|
|
sorcery coven drain <node-id> # Migrate builds off a node for maintenance
|
|
sorcery coven list # Show all known Sanctums
|
|
```
|
|
|
|
Distributed build scheduling is delegated to Fester when a cluster is active.
|
|
|
|
## 5. Tomb (Binary Storage)
|
|
|
|
```bash
|
|
sorcery tomb list # Show every Essence in the Tomb
|
|
sorcery tomb verify --all # Warding bit-rot check
|
|
sorcery tomb purge # Garbage-collect unreferenced blobs
|
|
```
|
|
|
|
## 6. Warding (Security)
|
|
|
|
```bash
|
|
sorcery ward status # Active alarms + quarantined nodes
|
|
sorcery ward banish <node-id> # Freeze a Sanctum and log the banishment
|
|
```
|
|
|
|
Transport security is handled at the network firewall layer (OPNsense / IPFire).
|
|
There are no certificates or key material to manage.
|
|
|
|
## 7. Legal Sentinel
|
|
|
|
```bash
|
|
sorcery legal audit # Scan fleet for license violations
|
|
sorcery legal sbom <essence_id> # CycloneDX SBOM on stdout
|
|
sorcery legal set-posture lawless # strict_copyleft | corporate_lite | lawless
|
|
sorcery legal credits --out ./DIR # Collect every COPYING / LICENSE file
|
|
```
|
|
|
|
## 8. Coven Mirror (WebUI)
|
|
|
|
```bash
|
|
sorcery web --port 8080
|
|
# -> http://localhost:8080
|
|
```
|
|
|
|
Tabs: Grimoire, Tomb, Pulse, Sanctum, Portable Bin, Compliance.
|
|
|
|
## 9. Portable Tool Bin
|
|
|
|
```bash
|
|
# Forge a static, portable version of a tool
|
|
sorcery cast procps --static --target aarch64 --essence-out ./portable-top.ess
|
|
|
|
# Generate the curated Emergency Kit
|
|
cauldron emergency-kit --bundle ./emergency.svb
|
|
```
|
|
|
|
## 10. First Flight (Genesis Ritual)
|
|
|
|
```bash
|
|
./scripts/forge_first_sanctum.sh
|
|
```
|
|
|
|
This automates the cast, seal, hydrate, and verify loop with a static busybox
|
|
Essence. If it succeeds, the Cauldron, Tomb, and Warding are operational. |