Initialize repository snapshot
This commit is contained in:
196
docs/skill/QUICK_REFERENCE.md
Normal file
196
docs/skill/QUICK_REFERENCE.md
Normal file
@@ -0,0 +1,196 @@
|
||||
# VaultMesh Quick Reference
|
||||
|
||||
## Eternal Pattern
|
||||
|
||||
```
|
||||
Intent → Engine → Receipt → Scroll → Anchor
|
||||
```
|
||||
|
||||
## Three Layers
|
||||
|
||||
| Layer | Components | Artifacts |
|
||||
|-------|------------|-----------|
|
||||
| L1 Experience | CLI, UI, MCP | Commands, requests |
|
||||
| L2 Engine | Domain logic | contract.json, state.json |
|
||||
| L3 Ledger | Receipts, anchors | JSONL, ROOT.*.txt |
|
||||
|
||||
## Scrolls
|
||||
|
||||
| Scroll | Path | Root File |
|
||||
|--------|------|-----------|
|
||||
| Drills | `receipts/drills/` | `ROOT.drills.txt` |
|
||||
| Compliance | `receipts/compliance/` | `ROOT.compliance.txt` |
|
||||
| Guardian | `receipts/guardian/` | `ROOT.guardian.txt` |
|
||||
| Treasury | `receipts/treasury/` | `ROOT.treasury.txt` |
|
||||
| Mesh | `receipts/mesh/` | `ROOT.mesh.txt` |
|
||||
| OffSec | `receipts/offsec/` | `ROOT.offsec.txt` |
|
||||
| Identity | `receipts/identity/` | `ROOT.identity.txt` |
|
||||
| Observability | `receipts/observability/` | `ROOT.observability.txt` |
|
||||
| Automation | `receipts/automation/` | `ROOT.automation.txt` |
|
||||
| PsiField | `receipts/psi/` | `ROOT.psi.txt` |
|
||||
| Federation | `receipts/federation/` | `ROOT.federation.txt` |
|
||||
| Governance | `receipts/governance/` | `ROOT.governance.txt` |
|
||||
|
||||
## DIDs
|
||||
|
||||
```
|
||||
did:vm:<type>:<identifier>
|
||||
|
||||
node → did:vm:node:brick-01
|
||||
human → did:vm:human:sovereign
|
||||
agent → did:vm:agent:copilot-01
|
||||
service → did:vm:service:oracle
|
||||
mesh → did:vm:mesh:vaultmesh-dublin
|
||||
```
|
||||
|
||||
## Phases
|
||||
|
||||
| Symbol | Phase | State |
|
||||
|--------|-------|-------|
|
||||
| 🜁 | Nigredo | Crisis |
|
||||
| 🜄 | Albedo | Recovery |
|
||||
| 🜆 | Citrinitas | Optimization |
|
||||
| 🜂 | Rubedo | Integration |
|
||||
|
||||
## Axioms
|
||||
|
||||
1. Receipts are append-only
|
||||
2. Hashes are cryptographic
|
||||
3. All changes produce receipts
|
||||
4. Constitution is supreme
|
||||
5. Axioms are immutable
|
||||
|
||||
## CLI Cheatsheet
|
||||
|
||||
```bash
|
||||
# Guardian
|
||||
vm-guardian anchor-status
|
||||
vm-guardian anchor-now --wait
|
||||
vm-guardian verify-receipt <hash> --scroll <scroll>
|
||||
|
||||
# Identity
|
||||
vm-identity did create --type node --id <id>
|
||||
vm-identity capability grant --subject <did> --capability <cap>
|
||||
vm-identity whoami
|
||||
|
||||
# Mesh
|
||||
vm-mesh node list
|
||||
vm-mesh node status <id>
|
||||
vm-mesh topology
|
||||
|
||||
# Oracle
|
||||
vm-oracle query "What are the GDPR requirements?"
|
||||
vm-oracle corpus status
|
||||
|
||||
# Drills
|
||||
vm-drills create --prompt "<scenario>"
|
||||
vm-drills status <drill-id>
|
||||
|
||||
# Psi
|
||||
vm-psi phase current
|
||||
vm-psi transmute start --input <ref>
|
||||
vm-psi opus status
|
||||
|
||||
# Treasury
|
||||
vm-treasury balance
|
||||
vm-treasury debit --from <acct> --amount <amt>
|
||||
|
||||
# Governance
|
||||
vm-gov constitution version
|
||||
vm-gov violations list
|
||||
vm-gov emergency status
|
||||
|
||||
# Federation
|
||||
vm-federation status
|
||||
vm-federation verify --mesh <peer>
|
||||
|
||||
# System
|
||||
vm-cli system health
|
||||
vm-cli receipts count --by-scroll
|
||||
```
|
||||
|
||||
## Receipt Structure
|
||||
|
||||
```json
|
||||
{
|
||||
"schema_version": "2.0.0",
|
||||
"type": "<scroll>_<operation>",
|
||||
"timestamp": "ISO8601",
|
||||
"header": {
|
||||
"root_hash": "blake3:...",
|
||||
"tags": [],
|
||||
"previous_hash": "blake3:..."
|
||||
},
|
||||
"meta": {
|
||||
"scroll": "ScrollName",
|
||||
"sequence": 0,
|
||||
"anchor_epoch": null,
|
||||
"proof_path": null
|
||||
},
|
||||
"body": {}
|
||||
}
|
||||
```
|
||||
|
||||
## Capabilities
|
||||
|
||||
| Capability | Description |
|
||||
|------------|-------------|
|
||||
| `anchor` | Submit to anchor backends |
|
||||
| `storage` | Store receipts/artifacts |
|
||||
| `compute` | Execute drills/agents |
|
||||
| `oracle` | Issue compliance answers |
|
||||
| `admin` | Grant/revoke capabilities |
|
||||
| `federate` | Establish cross-mesh trust |
|
||||
|
||||
## Trust Levels
|
||||
|
||||
| Level | Name | Access |
|
||||
|-------|------|--------|
|
||||
| 0 | isolated | None |
|
||||
| 1 | observe | Read-only |
|
||||
| 2 | verify | Mutual verification |
|
||||
| 3 | attest | Cross-attestation |
|
||||
| 4 | integrate | Shared scrolls |
|
||||
|
||||
## Severity Levels
|
||||
|
||||
| Level | Description |
|
||||
|-------|-------------|
|
||||
| critical | Active breach |
|
||||
| high | Confirmed attack |
|
||||
| medium | Suspicious activity |
|
||||
| low | Anomaly/info |
|
||||
|
||||
## Key Ports
|
||||
|
||||
| Service | HTTP | Metrics |
|
||||
|---------|------|---------|
|
||||
| Portal | 8080 | 9090 |
|
||||
| Guardian | 8081 | 9090 |
|
||||
| Oracle | 8082 | 9090 |
|
||||
| MCP | 8083 | - |
|
||||
|
||||
## Health Endpoints
|
||||
|
||||
```
|
||||
GET /health/live → Liveness
|
||||
GET /health/ready → Readiness
|
||||
GET /metrics → Prometheus
|
||||
```
|
||||
|
||||
## Transmutation Steps
|
||||
|
||||
```
|
||||
Extract → Dissolve → Purify → Coagulate → Seal
|
||||
```
|
||||
|
||||
## Design Gate
|
||||
|
||||
- [ ] Clear entrypoint?
|
||||
- [ ] Contract produced?
|
||||
- [ ] State object?
|
||||
- [ ] Receipts emitted?
|
||||
- [ ] Append-only JSONL?
|
||||
- [ ] Merkle root?
|
||||
- [ ] Guardian anchor path?
|
||||
- [ ] Query tool?
|
||||
Reference in New Issue
Block a user