Skip to content

Commit 405b5fd

Browse files
Copilottoolate28
andcommitted
Add comprehensive documentation for H&&S protocol and update README
Co-authored-by: toolate28 <105518313+toolate28@users.noreply.github.com>
1 parent 449b6d2 commit 405b5fd

20 files changed

Lines changed: 348 additions & 3072 deletions

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ yarn-error.log*
2020
package-lock.json
2121
.npm
2222
.yarn
23+
coverage/
2324

2425
# IDE
2526
.vscode/

README.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Wave Toolkit provides coherence detection tools and AI collaboration patterns fo
2121
- **[Wave Guide](wave.md)** — Philosophy, mechanics, and complete workflow guide
2222
- **[Communication Patterns](communication-patterns.md)** — What makes collaboration flow
2323
- **[AI Agent Rules](AI_AGENTS.md)** — Coordination rules for all AI agents
24+
- **[H&&S Protocol](docs/HANDSHAKE_PROTOCOL.md)** — Multi-agent handshake coordination (NEW!)
2425

2526
### 🌀 Workflow Guides (New!)
2627

@@ -61,6 +62,7 @@ Wave Toolkit is part of a unified framework for human-AI collaboration:
6162

6263
| Component | File | Purpose |
6364
|-----------|------|---------|
65+
| **H&&S Protocol** | `src/handshake/` | Multi-agent workflow coordination (TypeScript) |
6466
| **Context Capture** | `Get-WaveContext.ps1` | Snapshots your environment dynamically |
6567
| **Prompt Generator** | `New-ClaudeSystemPrompt.ps1` | Creates context-aware system prompts |
6668
| **Session Runner** | `Invoke-ClaudeSession.ps1` | Complete session workflow |
@@ -72,6 +74,39 @@ Wave Toolkit is part of a unified framework for human-AI collaboration:
7274

7375
---
7476

77+
## 🤝 H&&S (Handshake & Sign) Protocol
78+
79+
**NEW**: Multi-agent workflow coordination with verifiable state transitions.
80+
81+
```bash
82+
# Install dependencies
83+
npm install
84+
85+
# Create a handoff
86+
node dist/cli.js handoff create \
87+
--from claude --to grok \
88+
--state WAVE \
89+
--context '{"phase":"exploration"}' \
90+
--score 88
91+
92+
# View workflow chain
93+
node dist/cli.js handoff chain <session-id>
94+
95+
# Generate Mermaid visualization
96+
node dist/cli.js handoff viz <session-id> --output workflow.svg
97+
```
98+
99+
**Documentation**: See [docs/HANDSHAKE_PROTOCOL.md](docs/HANDSHAKE_PROTOCOL.md)
100+
101+
**Features**:
102+
- ✅ Agent-to-agent coordination (WAVE, PASS, BLOCK, HOLD, PUSH states)
103+
- ✅ ATOM trail integration for auditing
104+
- ✅ Workflow visualization via Mermaid
105+
- ✅ High performance (1000 handoffs <500ms)
106+
- ✅ TypeScript with 92%+ test coverage
107+
108+
---
109+
75110
## 📂 Project Structure
76111

77112
```
@@ -81,8 +116,22 @@ wave-toolkit/
81116
├── 📄 communication-patterns.md # Collaboration patterns
82117
├── 📄 AI_AGENTS.md # Agent coordination rules
83118
├── 📓 project-book.ipynb # Interactive Jupyter notebook
119+
├── 📄 package.json # Node.js dependencies (NEW)
120+
├── 📄 tsconfig.json # TypeScript config (NEW)
121+
122+
├── 📂 src/ # TypeScript source code (NEW)
123+
│ ├── 📂 handshake/ # H&&S Protocol implementation
124+
│ │ ├── types.ts # Core types and interfaces
125+
│ │ └── protocol.ts # Main HandshakeProtocol class
126+
│ ├── 📂 storage/ # Storage layer
127+
│ │ └── HandoffStorage.ts # JSONL storage manager
128+
│ ├── 📂 integrations/ # External integrations
129+
│ │ └── ATOMIntegration.ts # ATOM trail logging
130+
│ ├── cli.ts # Command-line interface
131+
│ └── index.ts # Public API exports
84132
85133
├── 📂 docs/ # Documentation
134+
│ ├── 📄 HANDSHAKE_PROTOCOL.md # H&&S Protocol guide (NEW)
86135
│ ├── 📂 guides/ # Workflow guides (NEW)
87136
│ │ ├── DEVELOPMENT_WORKFLOW.md # Develop→Prototype→Test→Refine
88137
│ │ ├── ORCHARD_VIEW.md # Multi-layer visualization
@@ -106,6 +155,8 @@ wave-toolkit/
106155
│ └── euler_number_usage.py # Proper use of Euler's number
107156
108157
├── 📂 tests/ # Test files
158+
│ ├── protocol.test.ts # H&&S Protocol tests (NEW)
159+
│ ├── atom-integration.test.ts # ATOM integration tests (NEW)
109160
│ ├── Wave.Logging.Tests.ps1 # PowerShell tests
110161
│ └── test_euler_number_usage.py # Python example tests
111162
@@ -129,10 +180,16 @@ cd wave-toolkit
129180
130181
# Run setup
131182
.\Setup-Wave.ps1
183+
184+
# Install TypeScript dependencies (for H&&S Protocol)
185+
npm install
186+
npm run build
132187
```
133188

134189
### Usage
135190

191+
#### PowerShell Tools
192+
136193
```powershell
137194
# Capture your environment context
138195
.\Get-WaveContext.ps1
@@ -144,6 +201,23 @@ cd wave-toolkit
144201
.\Consolidate-Scripts.ps1 -WhatIf # Preview changes first
145202
```
146203

204+
#### H&&S Protocol (TypeScript)
205+
206+
```bash
207+
# Create a handoff between agents
208+
node dist/cli.js handoff create \
209+
--from claude --to grok \
210+
--state WAVE \
211+
--context '{"phase":"exploration"}' \
212+
--score 88
213+
214+
# View handoff chain
215+
node dist/cli.js handoff chain <session-id>
216+
217+
# Generate workflow visualization
218+
node dist/cli.js handoff viz <session-id>
219+
```
220+
147221
---
148222

149223
## 🔧 Core Scripts
@@ -216,11 +290,23 @@ Wave operates on mutual trust:
216290

217291
## 🧪 Testing
218292

293+
### PowerShell Tests
294+
219295
```powershell
220296
# Run tests with Pester
221297
Invoke-Pester .\tests\
222298
```
223299

300+
### TypeScript Tests
301+
302+
```bash
303+
# Run all tests
304+
npm test
305+
306+
# Run with coverage report
307+
npm run test:coverage
308+
```
309+
224310
---
225311

226312
## 🤝 Contributing

coverage/clover.xml

Lines changed: 0 additions & 171 deletions
This file was deleted.

0 commit comments

Comments
 (0)