Skip to content

Commit e931be4

Browse files
authored
Update INSTRUCTIONS.md
1 parent 43b380a commit e931be4

1 file changed

Lines changed: 115 additions & 11 deletions

File tree

INSTRUCTIONS.md

Lines changed: 115 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
```markdown
21
# 🕹️ HELIX-TTD OPERATOR MANUAL
32
**Version:** v0.3.1 | **Status:** Live
43

@@ -50,9 +49,9 @@ streamlit run dashboard.py
5049
```
5150

5251
**Usage:**
53-
- The browser will open automatically (`http://localhost:8501`).
54-
- Enter the directory where your agents are stored (default is `.`).
55-
- Select an Agent ID from the dropdown.
52+
- The browser will open automatically (`http://localhost:8501`)
53+
- Enter the directory where your agents are stored (default is `.`)
54+
- Select an Agent ID from the dropdown
5655
- **Green Banner = Verified. Red Banner = Tampered.**
5756

5857
## 🔍 3. The Forensic Scanner (`tools/profile_auditor.py`)
@@ -92,12 +91,117 @@ A simulation of a 3-of-5 key signing ceremony to recover a "Rogue Agent." Use th
9291
# Generate a Teal 'ACTIVE' badge
9392
python3 cli/generate_hgl.py 0x[MERKLE_ROOT] ACTIVE --output svg --svg-file badge.svg
9493
```
94+
95+
## 🚀 6. New Feature: Batch Agent Creation (`tools/batch_mint.py`)
96+
**Role:** The Factory. Mint multiple agent identities in a single operation with configuration file.
97+
98+
**How to Run:**
99+
```bash
100+
# Create from YAML config
101+
python3 tools/batch_mint.py --config ./agent_batch.yaml --output-dir ./batch_agents
102+
103+
# Create from CSV manifest
104+
python3 tools/batch_mint.py --csv ./agent_manifest.csv --output-dir ./batch_agents
95105
```
96106

97-
**Formatted as clean GitHub Markdown with:**
98-
- Proper header hierarchy
99-
- Code blocks with language specification
100-
- Bold and italic emphasis where appropriate
101-
- Clear section separation
102-
- Warning callouts using emoji + bold formatting
103-
- List formatting for output descriptions
107+
**Config Example (`agent_batch.yaml`):**
108+
```yaml
109+
agents:
110+
- custodian: "team_alpha"
111+
name: "Alpha-01"
112+
state: "DRAFT"
113+
- custodian: "team_beta"
114+
name: "Beta-01"
115+
state: "ACTIVE"
116+
metadata:
117+
department: "security"
118+
tier: "production"
119+
```
120+
121+
## 🔗 7. New Feature: Cross-Chain Verification (`verification/chain_audit.py`)
122+
**Role:** The Auditor. Verify custody chains across multiple repositories or environments.
123+
124+
**How to Run:**
125+
```bash
126+
# Audit all agents in a directory tree
127+
python3 verification/chain_audit.py --root ./all_agents --report ./audit_report.json
128+
129+
# Compare two custody chains
130+
python3 verification/chain_audit.py --compare ./agents_v1 ./agents_v2 --output diff.html
131+
```
132+
133+
**Features:**
134+
- Merkle root continuity validation
135+
- Custodian change tracking
136+
- State transition auditing
137+
- HTML/JSON/CSV report generation
138+
139+
## 📊 8. New Feature: Analytics Dashboard (`analytics/usage_tracker.py`)
140+
**Role:** The Observer. Track adoption metrics and generate real-time visualizations.
141+
142+
**How to Run:**
143+
```bash
144+
# Generate clone analytics
145+
python3 analytics/usage_tracker.py --repo helix-ttd-dbc-suitcase --period 30d
146+
147+
# Real-time monitoring
148+
python3 analytics/usage_tracker.py --monitor --webhook https://hooks.slack.com/...
149+
```
150+
151+
**Metrics Tracked:**
152+
- Clone velocity over time
153+
- Unique developer trends
154+
- Geographic distribution
155+
- Integration patterns
156+
157+
## 🧪 9. New Feature: Integration Test Suite (`tests/integration_suite.py`)
158+
**Role:** The Validator. End-to-end testing of the entire Helix stack.
159+
160+
**How to Run:**
161+
```bash
162+
# Run full integration test
163+
python3 tests/integration_suite.py --full
164+
165+
# Test specific module
166+
python3 tests/integration_suite.py --module custody_chain --report junit
167+
```
168+
169+
**Test Coverage:**
170+
- DBC ↔ SUITCASE integrity
171+
- Merkle root propagation
172+
- State transition validation
173+
- Multi-sig quorum logic
174+
- Visual glyph generation
175+
176+
## 🛠️ Quick Start Template
177+
Create a `quickstart.sh` for rapid deployment:
178+
179+
```bash
180+
#!/bin/bash
181+
# HELIX-TTD Quick Deployment
182+
183+
echo "🚀 Setting up Helix-TTD Stack..."
184+
185+
# 1. Clone and install
186+
git clone https://github.com/your-org/helix-ttd-dbc-suitcase.git
187+
cd helix-ttd-dbc-suitcase
188+
pip install -e .
189+
190+
# 2. Mint first agent
191+
helix new-agent --custodian "team_$USER" --name "FirstAgent" --output-dir ./my_agents
192+
193+
# 3. Launch dashboard
194+
streamlit run dashboard.py &
195+
196+
# 4. Run integration tests
197+
python3 tests/integration_suite.py --quick
198+
199+
echo "✅ Helix stack deployed! Dashboard: http://localhost:8501"
200+
```
201+
202+
---
203+
204+
**📈 Status:** Features added. Substrate expanding. The reef grows deeper.
205+
**🦆 Note:** Each new feature follows the same pattern — solve, ship, spread. No hype, just utility.
206+
207+
🔒✧~◯△

0 commit comments

Comments
 (0)