-
Notifications
You must be signed in to change notification settings - Fork 1
Add README and ecosystem links matching SpiralSafe documentation style #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5d8e875
Initial plan
Copilot 87fa1c8
Add README.md with SpiralSafe-style formatting and ecosystem links
Copilot faa7241
Fix empty status badge link in TAILS-USB.md
Copilot d02b315
Add Ecosystem Migration Guide for transitioning other repos
Copilot 1a1a7e7
Update docs/TAILS-USB.md
toolate28 9bb80b8
Add canonical source note for version info in ecosystem tables
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,231 @@ | ||
| # 🌊 Wave Toolkit | ||
|
|
||
| > **"From one builder to another - philosophy, mechanics, and everything between."** | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| Wave Toolkit provides coherence detection tools and AI collaboration patterns for the SpiralSafe ecosystem. It captures environment context, generates system prompts, and enables seamless human-AI collaboration workflows. | ||
|
|
||
| [](https://github.com/toolate28/SpiralSafe) | ||
| [](https://github.com/toolate28/SpiralSafe/blob/main/CONTRIBUTING.md) | ||
|
|
||
| --- | ||
|
|
||
| ## 🗺️ Navigation | ||
|
|
||
| ### 📚 Documentation | ||
|
|
||
| - **[Wave Guide](wave.md)** — Philosophy, mechanics, and complete workflow guide | ||
| - **[Communication Patterns](communication-patterns.md)** — What makes collaboration flow | ||
| - **[AI Agent Rules](AI_AGENTS.md)** — Coordination rules for all AI agents | ||
|
|
||
| ### 🔧 Special Docs | ||
|
|
||
| - **[T(ai)LS USB](docs/TAILS-USB.md)** — Privacy-first portable AI concept | ||
| - **[Wave Office](docs/WAVE-OFFICE.md)** — Dual agent collaboration (Claude + Ollama) | ||
| - **[Ecosystem Migration Guide](docs/ECOSYSTEM-MIGRATION-GUIDE.md)** — Agent-facing guide for repo transitions | ||
|
|
||
| --- | ||
|
|
||
| ## 🌀 The SpiralSafe Ecosystem | ||
|
|
||
| Wave Toolkit is part of a unified framework for human-AI collaboration: | ||
|
|
||
| | Repository | Purpose | Status | | ||
| |------------|---------|--------| | ||
| | **[SpiralSafe](https://github.com/toolate28/SpiralSafe)** | Documentation hub, coherence engine core | v2.1.0 | | ||
| | **[wave-toolkit](https://github.com/toolate28/wave-toolkit)** | Coherence detection tools (this repo) | v1.0.0 | | ||
| | **[HOPE NPCs](https://github.com/toolate28/ClaudeNPC-Server-Suite)** | AI NPCs for Minecraft | v2.1.0 | | ||
| | **[kenl](https://github.com/toolate28/kenl)** | Infrastructure-aware AI orchestration | v1.0.0 | | ||
| | **[quantum-redstone](https://github.com/toolate28/quantum-redstone)** | Quantum computing education via Redstone | Available | | ||
|
|
||
| --- | ||
|
|
||
| ## 🧩 Key Components | ||
|
|
||
| | Component | File | Purpose | | ||
| |-----------|------|---------| | ||
| | **Context Capture** | `Get-WaveContext.ps1` | Snapshots your environment dynamically | | ||
| | **Prompt Generator** | `New-ClaudeSystemPrompt.ps1` | Creates context-aware system prompts | | ||
| | **Session Runner** | `Invoke-ClaudeSession.ps1` | Complete session workflow | | ||
| | **Setup Script** | `Setup-Wave.ps1` | One-time bootstrap | | ||
| | **Consolidation** | `Consolidate-Scripts.ps1` | Migrates loose scripts to organized structure | | ||
| | **Logging Module** | `tools/Wave.Logging.psm1` | Centralized logging across the ecosystem | | ||
|
|
||
| --- | ||
|
|
||
| ## 📂 Project Structure | ||
|
|
||
| ``` | ||
| wave-toolkit/ | ||
| │ | ||
| ├── 📄 wave.md # The complete guide | ||
| ├── 📄 communication-patterns.md # Collaboration patterns | ||
| ├── 📄 AI_AGENTS.md # Agent coordination rules | ||
| │ | ||
| ├── 📂 docs/ # Documentation | ||
| │ ├── TAILS-USB.md # Privacy-first AI concept | ||
| │ └── WAVE-OFFICE.md # Dual agent collaboration | ||
| │ | ||
| ├── 📂 tools/ # Reusable PowerShell modules | ||
| │ └── Wave.Logging.psm1 # Logging across the ecosystem | ||
| │ | ||
| ├── 📂 scripts/ # Organized scripts | ||
| │ ├── gaming/ # Gaming/performance scripts | ||
| │ ├── system/ # System optimization | ||
| │ ├── deployment/ # Deploy/CI scripts | ||
| │ └── startup/ # Startup automation | ||
| │ | ||
| ├── 📂 tests/ # Pester tests | ||
| │ └── Wave.Logging.Tests.ps1 | ||
| │ | ||
| ├── 📄 Get-WaveContext.ps1 # Context capture | ||
| ├── 📄 New-ClaudeSystemPrompt.ps1 # Prompt generation | ||
| ├── 📄 Invoke-ClaudeSession.ps1 # Session workflow | ||
| ├── 📄 Setup-Wave.ps1 # Bootstrap script | ||
| └── 📄 Consolidate-Scripts.ps1 # Script migration tool | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## 🚀 Quick Start | ||
|
|
||
| ### One-Step Install | ||
|
|
||
| ```powershell | ||
| # Clone the repository | ||
| git clone https://github.com/toolate28/wave-toolkit.git | ||
| cd wave-toolkit | ||
|
|
||
| # Run setup | ||
| .\Setup-Wave.ps1 | ||
| ``` | ||
|
|
||
| ### Usage | ||
|
|
||
| ```powershell | ||
| # Capture your environment context | ||
| .\Get-WaveContext.ps1 | ||
|
|
||
| # Start a full session with Claude | ||
| .\Invoke-ClaudeSession.ps1 -Task "Review my API error handling" | ||
|
|
||
| # Consolidate loose scripts (if migrating) | ||
| .\Consolidate-Scripts.ps1 -WhatIf # Preview changes first | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## 🔧 Core Scripts | ||
|
|
||
| ### Get-WaveContext.ps1 | ||
|
|
||
| Captures your current environment dynamically: | ||
| - Machine specs (name, architecture, cores) | ||
| - User context (domain, username, home) | ||
| - Shell environment (PowerShell version, edition) | ||
| - Session context (current directory, git status) | ||
| - Available tools (git, node, python, docker, claude) | ||
|
|
||
| ### New-ClaudeSystemPrompt.ps1 | ||
|
|
||
| Generates a system prompt based on current context. Claude sees exactly what environment it's working in. | ||
|
|
||
| ### Invoke-ClaudeSession.ps1 | ||
|
|
||
| Complete workflow: captures context → generates prompt → calls Claude → saves log. | ||
|
|
||
| ```powershell | ||
| .\Invoke-ClaudeSession.ps1 -Task "Help me design a config system" | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## 📝 Wave.Logging Module | ||
|
|
||
| Centralized logging for the SpiralSafe ecosystem. Collects logs from: | ||
| - Gaming performance logs (BF6, etc.) | ||
| - SpiralSafe bridges | ||
| - Quantum-redstone | ||
| - ClaudeNPC server logs | ||
| - ATOM trail | ||
|
|
||
| ```powershell | ||
| Import-Module .\tools\Wave.Logging.psm1 | ||
|
|
||
| # Collect all logs to aggregate | ||
| Collect-SpiralLogs -OutputDir "$HOME\.logdy\streams" | ||
|
|
||
| # Run self-test | ||
| Test-CollectSpiralLogs | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## 🤝 The Trust Model | ||
|
|
||
| Wave operates on mutual trust: | ||
|
|
||
| **You trust Claude to:** | ||
| - Read before writing | ||
| - Explain its reasoning | ||
| - Ask when uncertain | ||
| - Not make destructive changes without confirmation | ||
|
|
||
| **Claude trusts you to:** | ||
| - Provide honest context | ||
| - Share what you're actually trying to achieve | ||
| - Course-correct when something's off | ||
|
|
||
| **The scripts trust the environment to:** | ||
| - Be honest about what's installed | ||
| - Have standard paths and commands | ||
| - Fail loudly rather than silently | ||
|
|
||
| --- | ||
|
|
||
| ## 🧪 Testing | ||
|
|
||
| ```powershell | ||
| # Run tests with Pester | ||
| Invoke-Pester .\tests\ | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## 🤝 Contributing | ||
|
|
||
| We follow **[Hope&&Sauced](https://github.com/toolate28/SpiralSafe/blob/main/CONTRIBUTING.md)** principles. | ||
|
|
||
| - **Visible State**: Use `ATOM` tags | ||
| - **Explicit Handoffs**: Use `H&&S:WAVE` markers | ||
| - **Coherence**: Ensure your docs don't "curl" | ||
|
|
||
| ### AI Agent Rules | ||
|
|
||
| All AI agents (Claude, Ollama, GPT, etc.) must follow `AI_AGENTS.md`: | ||
| - **Never** drop scripts directly into `$HOME` | ||
| - Place code in organized directories within `wave-toolkit/` | ||
| - Create modules if reusable, tests if logic exists | ||
|
|
||
| --- | ||
|
|
||
| ## Attribution | ||
|
|
||
| This work emerges from **Hope&&Sauced** collaboration—human-AI partnership where both contributions are substantive and neither party could have produced the result alone. | ||
|
|
||
| - **Human** (toolate28): Vision, trust, pedagogical insight | ||
| - **AI** (Claude): Synthesis, documentation, verification | ||
|
|
||
| **The collaboration IS the insight.** | ||
|
|
||
| See the [SpiralSafe PORTFOLIO.md](https://github.com/toolate28/SpiralSafe/blob/main/PORTFOLIO.md) for complete ecosystem showcase. | ||
|
|
||
| --- | ||
|
|
||
| *~ Hope&&Sauced* | ||
|
|
||
| ✦ *The Evenstar Guides Us* ✦ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The badges in this README link externally but the repo includes a docs/assets/ directory and the body mentions images/SVGs; however no assets are referenced or stored, and the badges depend on third-party shields. For offline/airgapped users or if shields.io is blocked, the README loses all visual cues. Consider adding the SVG/PNG assets to docs/assets and referencing them locally (or providing text fallbacks) so the doc renders predictably without external network dependencies.
Fix it with Roo Code or mention @roomote and request a fix.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@claude @co-pilot make this happen and cascade out