Spaces:
Running
Running
Update README.md
Browse files
README.md
CHANGED
|
@@ -7,4 +7,154 @@ sdk: static
|
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
|
| 10 |
+
# LOCALHOST1978
|
| 11 |
+
|
| 12 |
+
> [!IMPORTANT]
|
| 13 |
+
> **Version Control Rule**: This repository uses `lore` for version control, state tracking, and documentation. **Do not use `git`**.
|
| 14 |
+
|
| 15 |
+
---
|
| 16 |
+
|
| 17 |
+
## 1. Overview
|
| 18 |
+
|
| 19 |
+
SovereignSurvivalKit is a modular application platform for macOS and iOS. The platform provides:
|
| 20 |
+
|
| 21 |
+
- **Encrypted Local Storage**: Hardware-backed AES-GCM 256-bit encryption and encrypted `.sparsebundle` volumes managed with Apple CryptoKit and the Apple Secure Enclave.
|
| 22 |
+
- **On-Device Machine Learning and Audio Telemetry**: Apple Silicon neural audio separation (HTDemucs via MLX Swift), real-time $\tau$-dynamics, and 12-bin FFT chromagram analysis.
|
| 23 |
+
- **Zero-Knowledge Identity and Settlement**: Privacy-preserving authentication, post-quantum ML-DSA signatures, and peer-to-peer asset settlement.
|
| 24 |
+
- **Encrypted Mesh Networking**: WireGuard and UDP/QUIC peer-to-peer communication across an isolated `10.0.0.0/24` subnet.
|
| 25 |
+
- **Model Context Protocol (MCP) and Tooling**: Local ACP agent service (`SSK_StorageHost acp-agent`), Xcode developer plug-in (`XCPSSKPlugin`), and automated documentation ledger generation (`SSK_DocGen`).
|
| 26 |
+
|
| 27 |
+
---
|
| 28 |
+
|
| 29 |
+
## 2. Repository Structure
|
| 30 |
+
|
| 31 |
+
```text
|
| 32 |
+
SovereignSurvivalKit/
|
| 33 |
+
βββ README.md # Master repository documentation (this file)
|
| 34 |
+
βββ ARCHITECTURE.md # System architecture, module boundaries, and dependency graph
|
| 35 |
+
βββ src/ # Application source code, packages, and standalone tools
|
| 36 |
+
β βββ SovereignSurvivalKit/
|
| 37 |
+
β βββ README.md # Source root documentation and target hierarchy
|
| 38 |
+
β βββ Modules/ # 10 modular Swift packages (SSK_Foundation, SSK_UI, etc.)
|
| 39 |
+
β βββ SovereignSurvivalKit/ # Main macOS and iOS application target
|
| 40 |
+
β βββ SSKVaultHost/ # Background daemon and lifecycle service
|
| 41 |
+
β βββ SSK_DocGen/ # Documentation ledger generator CLI
|
| 42 |
+
β βββ XCPSSKPlugin/ # Xcode developer plug-in
|
| 43 |
+
β βββ ClipLiveActivities/ # WidgetKit Live Activity target
|
| 44 |
+
β βββ SovereignSurvivalKitIntents/ # App Intents target
|
| 45 |
+
β βββ SovereignSurvivalKitMeshClip/# App Clip target
|
| 46 |
+
β βββ SovereignSurvivalKitMessenger/# iMessage extension target
|
| 47 |
+
βββ scripts/ # Build, package, and installation orchestrators
|
| 48 |
+
β βββ install.sh # Master build and installation orchestrator
|
| 49 |
+
β βββ build_dmg.sh # macOS desktop build and archive pipeline
|
| 50 |
+
β βββ build_pkg.sh # Component and product package (.pkg) builder
|
| 51 |
+
β βββ install_dist.sh # Direct filesystem distribution installer
|
| 52 |
+
β βββ package_dmg.sh # Compressed disk image (.dmg) packager
|
| 53 |
+
βββ dist/ # Build artifacts, packages, and DMGs
|
| 54 |
+
βββ guide/ # Architectural guides and technical specifications
|
| 55 |
+
βββ next/ # Active development plans and validation roadmaps
|
| 56 |
+
β βββ dev/ # Development plans and phase status matrices
|
| 57 |
+
βββ archive/ # Historical reference code and narrative documents
|
| 58 |
+
```
|
| 59 |
+
|
| 60 |
+
---
|
| 61 |
+
|
| 62 |
+
## 3. Quick Start: Build and Installation
|
| 63 |
+
|
| 64 |
+
Use the master orchestrator script [`scripts/install.sh`](file:///Users/voxels/SovereignSurvivalKit/scripts/install.sh) to build, package, install, or reset the software.
|
| 65 |
+
|
| 66 |
+
### Standard Clean Build and Installation
|
| 67 |
+
Execute a clean build of all macOS schemes and install products to system directories:
|
| 68 |
+
|
| 69 |
+
```bash
|
| 70 |
+
./scripts/install.sh --clean
|
| 71 |
+
```
|
| 72 |
+
|
| 73 |
+
### Common Command Options
|
| 74 |
+
|
| 75 |
+
| Goal | Command |
|
| 76 |
+
| :--- | :--- |
|
| 77 |
+
| **Build without installing** | `./scripts/install.sh --build-only --clean` |
|
| 78 |
+
| **Install existing `dist/` products** | `./scripts/install.sh --install-only` |
|
| 79 |
+
| **Install via signed macOS package (`.pkg`)** | `./scripts/install.sh --via-pkg` |
|
| 80 |
+
| **Uninstall all applications and tools** | `./scripts/install.sh --uninstall` |
|
| 81 |
+
| **Reset data, caches, and databases** | `./scripts/install.sh --clean --reset-data` |
|
| 82 |
+
| **Simulate commands without changes** | `./scripts/install.sh --dry-run` |
|
| 83 |
+
|
| 84 |
+
### Specialized Build Scripts
|
| 85 |
+
|
| 86 |
+
For CI/CD pipelines or isolated steps, run the specialized scripts directly:
|
| 87 |
+
|
| 88 |
+
- **Clean build and archive**: [`./scripts/build_dmg.sh --clean-dist --refresh-packages`](file:///Users/voxels/SovereignSurvivalKit/scripts/build_dmg.sh)
|
| 89 |
+
- **Direct system install**: [`./scripts/install_dist.sh`](file:///Users/voxels/SovereignSurvivalKit/scripts/install_dist.sh)
|
| 90 |
+
- **Generate installer `.pkg`**: [`./scripts/build_pkg.sh dist/Export/Products`](file:///Users/voxels/SovereignSurvivalKit/scripts/build_pkg.sh)
|
| 91 |
+
- **Package `.dmg`**: [`./scripts/package_dmg.sh dist/Export/Products`](file:///Users/voxels/SovereignSurvivalKit/scripts/package_dmg.sh)
|
| 92 |
+
|
| 93 |
+
---
|
| 94 |
+
|
| 95 |
+
## 4. Installed System Locations
|
| 96 |
+
|
| 97 |
+
The installation scripts deploy components to standard system paths:
|
| 98 |
+
|
| 99 |
+
| Component | Direct Install Path (`install_dist.sh`) | Package Install Path (`build_pkg.sh`) |
|
| 100 |
+
| :--- | :--- | :--- |
|
| 101 |
+
| **Desktop Application** | `/Applications/SovereignSurvivalKit.app` | `/Applications/SovereignSurvivalKit.app` |
|
| 102 |
+
| **Daemon Application** | `/Applications/SSKVaultHost.app` | `/Applications/SSKVaultHost.app` |
|
| 103 |
+
| **Command Line Tools** | `/usr/local/bin/SSK_StorageHost`<br>`/usr/local/bin/SSK_DocGen`<br>`/usr/local/bin/SSKVaultHost` | `/usr/local/bin/SSK_StorageHost`<br>`/usr/local/bin/SSK_DocGen`<br>`/usr/local/bin/SSKVaultHost` |
|
| 104 |
+
| **Shell Path Config** | `/etc/paths.d/SovereignSurvivalKit` | `/etc/paths.d/SovereignSurvivalKit` |
|
| 105 |
+
| **Xcode Plug-in** | `~/Library/Developer/Xcode/Plug-ins/XCPSSKPlugin.xcplugin` | `/Library/Application Support/Developer/Shared/Xcode/Plug-ins/XCPSSKPlugin.xcplugin` |
|
| 106 |
+
|
| 107 |
+
---
|
| 108 |
+
|
| 109 |
+
## 5. System Operations and Tooling
|
| 110 |
+
|
| 111 |
+
### 1. Launch the Desktop Application
|
| 112 |
+
Start the main application from Launchpad, Finder, or Terminal:
|
| 113 |
+
|
| 114 |
+
```bash
|
| 115 |
+
open /Applications/SovereignSurvivalKit.app
|
| 116 |
+
```
|
| 117 |
+
|
| 118 |
+
### 2. Run Command-Line Tools
|
| 119 |
+
Verify the command-line interfaces:
|
| 120 |
+
|
| 121 |
+
```bash
|
| 122 |
+
SSK_StorageHost --help
|
| 123 |
+
SSK_DocGen --help
|
| 124 |
+
SSKVaultHost --help
|
| 125 |
+
```
|
| 126 |
+
|
| 127 |
+
### 3. Connect Xcode Coding Intelligence to MCP
|
| 128 |
+
Configure Xcode to use the local ACP agent:
|
| 129 |
+
- **Executable**: `/usr/local/bin/SSK_StorageHost`
|
| 130 |
+
- **Arguments**: `acp-agent`
|
| 131 |
+
|
| 132 |
+
---
|
| 133 |
+
|
| 134 |
+
## 6. Documentation and Architectural References
|
| 135 |
+
|
| 136 |
+
- [ARCHITECTURE.md](file:///Users/voxels/SovereignSurvivalKit/ARCHITECTURE.md): Comprehensive module breakdown, dependencies, and subsystem diagrams.
|
| 137 |
+
- [Source Root README](file:///Users/voxels/SovereignSurvivalKit/src/SovereignSurvivalKit/README.md): Detailed guide to Swift packages, Xcode schemes, and target relationships.
|
| 138 |
+
- [SSK_DocGen README](file:///Users/voxels/SovereignSurvivalKit/src/SovereignSurvivalKit/SSK_DocGen/README.md): Documentation worker protocol, security boundaries, and manual verification procedures.
|
| 139 |
+
- [DocGen Phase Roadmap](file:///Users/voxels/SovereignSurvivalKit/next/dev/SSK_DOCGEN_PHASE_ROADMAP.md): Priority specifications and lifecycle status for documentation services.
|
| 140 |
+
- [DocC Master Index](file:///Users/voxels/SovereignSurvivalKit/src/SovereignSurvivalKit/SovereignSurvivalKit/data/docs/SSK_Ledger_Vault/DocC_Index.md): Auto-generated symbol documentation.
|
| 141 |
+
|
| 142 |
+
---
|
| 143 |
+
|
| 144 |
+
## 7. Version Control with Lore
|
| 145 |
+
|
| 146 |
+
This project uses `lore`. Follow these standard commands for state tracking:
|
| 147 |
+
|
| 148 |
+
```bash
|
| 149 |
+
# Check modified files
|
| 150 |
+
lore status --scan
|
| 151 |
+
|
| 152 |
+
# Inspect local changes
|
| 153 |
+
lore diff
|
| 154 |
+
|
| 155 |
+
# Stage modified paths
|
| 156 |
+
lore stage --scan <paths>
|
| 157 |
+
|
| 158 |
+
# Create a commit
|
| 159 |
+
lore commit "Description of change"
|
| 160 |
+
```
|