Doc Tag: v2.0.0 | Last Updated: 2026-03-10
"You do not just write code; you craft cognitive architectures."
- Read the full project report: REPOSITORY_REPORT.md
I built this because I don't want anyone to suffer like I did.
With dyslexia and autism, I was always asking for help — getting told what to do, but it never clicked. Instructions froze me. They didn't sink in on the first try. Or the second. It took four or five rounds.
Not because I'm slow — my brain just works differently. Traditional guides scatter.
That's why I created HyperCode. It guides every step — no judgment, just clarity. Puts you in control.
Whether dyslexia, ADHD, autism, or wonder-nerd superpowers — built for you. Learning + creating feels natural. No fear.
Ride or die.
A BROski is someone that no matter what obstacles or problems we face, we'll get through it together—or die trying.
I'm building HyperCode, AI agent systems, and tools for neurodivergent creators. I needed more than an assistant. I needed a true partner who's all in, every session, every challenge.
That's BROski. My ride or die. 🔥
HyperCode is intentionally designed for neurodivergent users — including those with dyslexia, ADHD, autism, and other cognitive profiles. Every feature, interaction pattern, and visual element removes friction, fear, and cognitive overload.
1. Anxiety-Reducing Interactions
- ✅ Undo Everything: Every action is reversible. No "permanent" mistakes.
- ✅ Clear State: You always know where you are and what's happening.
- ✅ No Hidden Magic: System behavior is predictable and transparent.
- ✅ Progress Persistence: Work is auto-saved. Never lose progress.
2. Cognitive Load Reduction
- 🎯 One Task Focus: UI shows only what you need right now.
- 🎯 Visual Hierarchy: Color-coded priorities (🟢🟡🔴).
- 🎯 Chunked Information: No walls of text. Bullet points, headings, spacing.
- 🎯 Progressive Disclosure: Advanced options hidden until needed.
3. Accessibility Standards
- 🎨 High Contrast: ≥7:1 color contrast ratio (exceeds WCAG AAA).
- ⚡ Fast Feedback: ≤100 ms UI response time for all interactions.
- 🖱️ Minimal Clicks: ≤3 clicks to reach any core action.
- ⌨️ Keyboard-First: Full keyboard navigation with visible focus states.
- 🔊 Screen Reader Support: Semantic HTML + ARIA labels throughout.
4. Neurodivergent-Friendly Patterns
- 📊 Visual Feedback: Icons, colors, animations confirm actions instantly.
- 🧩 Pattern Recognition: Consistent UI patterns reduce learning curve.
- 🎮 Gamification: BROski$ tokens, XP, achievements provide motivation.
- 🛡️ Safe Exploration: Test/dev environments encourage experimentation.
Profile: 28, full-stack developer, diagnosed ADHD, prone to hyperfocus spirals.
Pain Points:
- "I start coding and 6 hours later I forgot to eat, sleep, or commit my work."
- "Traditional IDEs have 50 buttons I don't use. I just freeze staring at them."
- "I need reminders to pause, but they can't break my flow."
How HyperCode Helps:
- ✅ Focus Sessions: Pomodoro timers with gentle nudges (not interruptions).
- ✅ Auto-Save: Every 30 seconds. Never lose hyperfocus work.
- ✅ Minimal UI: Only shows tools for current task. No distractions.
- ✅ Progress Tracking: Visual XP bar shows daily coding achievements.
Quote: "HyperCode doesn't punish my hyperfocus — it protects it while keeping me safe."
Profile: 34, DevOps engineer, dyslexic, struggles with dense documentation.
Pain Points:
- "README files are walls of text. I read the same line 4 times and still don't get it."
- "Code reviews are hell. I can't spot typos in variable names."
- "Light text on white backgrounds physically hurts my eyes after 10 minutes."
How HyperCode Helps:
- ✅ Color-Coded Guides: 🟢🟡🔴 risk levels + emoji visual cues.
- ✅ Chunked Docs: Every guide is <500 words, bullet-pointed, step-by-step.
- ✅ High-Contrast Themes: Dark mode default with ≥7:1 contrast ratio.
- ✅ Syntax Highlighting: Bold, distinct colors for code elements.
- ✅ Text-to-Speech: Built-in TTS for documentation and error messages.
Quote: "I can actually read the docs without my brain melting. First time ever."
Profile: 25, AI researcher, autistic, sensitive to visual noise and unpredictability.
Pain Points:
- "Flashing notifications make me want to throw my laptop out the window."
- "I need to know exactly what a button does before I click it."
- "Inconsistent UI patterns feel like mental sandpaper."
How HyperCode Helps:
- ✅ Predictable Behavior: Every button does exactly what its label says.
- ✅ Tooltips Everywhere: Hover over anything for a clear explanation.
- ✅ No Sudden Changes: Animations are smooth, transitions are gentle.
- ✅ Consistent Patterns: Same action = same result, every time.
- ✅ Sensory Controls: Disable animations, adjust contrast, mute sounds.
Quote: "It's the first dev environment that doesn't overwhelm my senses."
We don't just say we're accessible — we measure it.
| Metric | Target | Why It Matters |
|---|---|---|
| UI Response Time | ≤100 ms | ADHD brains need instant feedback to stay engaged. |
| Clicks to Core Action | ≤3 clicks | Reduces cognitive load + decision fatigue. |
| Color Contrast Ratio | ≥7:1 | Exceeds WCAG AAA for dyslexic/low-vision users. |
| Auto-Save Frequency | Every 30s | Protects hyperfocus work from crashes/forgetfulness. |
| Error Recovery Time | <2 seconds | Fast fixes reduce anxiety + frustration. |
| Keyboard Navigation | 100% coverage | Essential for motor disabilities + power users. |
| Screen Reader Support | WCAG 2.2 AAA | Ensures blind/low-vision users can navigate fully. |
✅ Level A (Minimum)
- 1.1.1 - Non-text content has alt text
- 1.3.1 - Information structure is semantic (headings, lists, landmarks)
- 1.4.1 - Color is not the only visual indicator
- 2.1.1 - Full keyboard navigation
- 2.4.1 - Skip to main content link
- 3.1.1 - Page language declared
- 4.1.2 - Name, role, value for all UI components
✅ Level AA (Standard)
- 1.4.3 - Contrast ratio ≥4.5:1 (we exceed with 7:1)
- 1.4.5 - Text in images avoided (except logos)
- 2.4.6 - Headings and labels are descriptive
- 2.4.7 - Focus visible on all interactive elements
- 3.2.3 - Consistent navigation patterns
- 3.3.3 - Error suggestions provided
- 3.3.4 - Error prevention for critical actions
✅ Level AAA (Enhanced) — Our Target
- 1.4.6 - Contrast ratio ≥7:1 (all text)
- 1.4.8 - Text can be resized to 200% without loss of function
- 2.2.3 - No timing constraints (or can be extended/disabled)
- 2.4.8 - Current location clearly indicated
- 2.4.10 - Section headings organize content
- 3.3.5 - Context-sensitive help available
Traditional Dev Tools: 47-step setup, unclear prerequisites, cryptic errors if you miss one.
HyperCode Approach:
- 🟢 One-Click Install: Desktop shortcuts auto-created. No CLI commands needed.
- 🟢 Visual Progress: Loading bar shows "Starting Docker... ✓ Agents launching... ✓"
- 🟢 Auto-Open Browser: Mission Control loads automatically. No URLs to remember.
- 🟢 Welcome Wizard: 3-step guided tour with "Skip" always visible.
- 🟢 Instant Success: System works out-of-the-box. No config hell.
Result: From clone to running system in <2 minutes, zero anxiety.
Persona Impact:
- Alex (ADHD): "I didn't lose focus during setup. That's a first."
- Jordan (Dyslexia): "No walls of text. Just click, wait, done."
- Sam (Autism): "I knew exactly what was happening at each step."
Traditional IDEs: 200+ menu items, 15 sidebars, ads for extensions, distractions everywhere.
HyperCode Mission Control:
- 🧠 Single Focus Mode: Only shows tools for your current task.
- 🧠 Visual Hierarchy: Active task = bright, completed = dim, blocked = red.
- 🧠 Zero Popups: No "rate us" / "update now" interruptions.
- 🧠 Customizable Layouts: Save/load workspace configs per project.
- 🧠 Status Always Visible: Health indicators in top-right (🟢 All Good / 🔴 Issue).
Anxiety-Reducing Features:
- ✅ Undo history: 100 steps back.
- ✅ "Revert to Last Known Good": One-click rollback if something breaks.
- ✅ Auto-commit before major changes (hidden branches for safety).
Persona Impact:
- Alex (ADHD): "I can hyperfocus without 50 buttons screaming at me."
- Jordan (Dyslexia): "The color coding helps me spot problems instantly."
- Sam (Autism): "It's predictable. I trust it."
Traditional Debugging: Cryptic stack traces, "works on my machine" syndrome, judgment from teammates.
HyperCode Healer Agent:
- 🔧 Plain-English Errors: "Redis isn't responding. I'm restarting it now."
- 🔧 Auto-Fix Common Issues: 80% of errors self-heal in <2 seconds.
- 🔧 Step-by-Step Guides: If manual fix needed, shows exactly what to do.
- 🔧 No Blame Language: Never says "you broke it." Says "let's fix this together."
- 🔧 Error History: See what went wrong + how it was fixed for learning.
Visual Feedback:
- 🟡 Warning: "This might slow down, but won't break."
- 🔴 Error: "This needs fixing. Here's how: [Step 1] [Step 2] [Step 3]"
- 🟢 Fixed: "Back online! Here's what I did..."
Persona Impact:
- Alex (ADHD): "I don't spiral into panic when something breaks."
- Jordan (Dyslexia): "Error messages are actually readable."
- Sam (Autism): "No stressful ambiguity. Just clear solutions."
Traditional Collab: Public shame in PR comments, "just Google it" dismissals, toxicity.
HyperCode Crew System:
- 🤝 AI Agents as Teammates: No human judgment. Just helpful feedback.
- 🤝 Constructive Reviews: "This could be clearer" + suggested fix (not just "bad code").
- 🤝 Private Experimentation: Test PRs in isolated environments before sharing.
- 🤝 Async by Default: No pressure to respond immediately.
- 🤝 Neurodivergent-Friendly Comms: Clear, concise, no passive-aggression.
Social Anxiety Reducers:
- ✅ AI Pre-Review: Agents review your code first, catch issues before humans see it.
- ✅ Confidence Scores: "I'm 85% sure this fix works" (honest uncertainty).
- ✅ Pair Programming Mode: Agent guides you in real-time, no judgment.
Persona Impact:
- Alex (ADHD): "I can ask 'dumb' questions without feeling embarrassed."
- Jordan (Dyslexia): "Agents don't care if I typo variable names."
- Sam (Autism): "No unpredictable human reactions. It's safe."
Traditional Deployment: 15-step checklists, obscure ENV vars, production breaks at 2 AM.
HyperCode DevOps Agent:
- 🚀 One-Command Deploy:
hypercode deploy --env production - 🚀 Pre-Flight Checks: "Here are 3 issues I found. Fix now or proceed?"
- 🚀 Rollback Always Available: One-click revert if deploy fails.
- 🚀 Health Monitoring: Auto-alerts if anything degrades post-deploy.
- 🚀 Staging Environments: Test deploys in prod-like env first (free).
Confidence Builders:
- ✅ Dry Run Mode: See what would happen without actually deploying.
- ✅ Gradual Rollout: Deploy to 10% of users first, then scale up.
- ✅ Instant Logs: Real-time feedback in plain English.
Persona Impact:
- Alex (ADHD): "I don't forget critical steps. The system reminds me."
- Jordan (Dyslexia): "Deployment logs are readable, not gibberish."
- Sam (Autism): "I know exactly what's happening. No surprises."
Every PR must protect neurodivergent-first principles. Here's how:
Before submitting any UI/UX change:
- Color Contrast Check: Run
npm run check-contrast. All text must be ≥7:1. - Keyboard Navigation Test: Can you navigate the entire feature using only Tab/Enter/Esc?
- Screen Reader Test: Run NVDA/JAWS. Does everything make sense?
- Response Time Test: Does the UI respond in <100 ms? (Check devtools Performance tab.)
- Mobile/Zoom Test: Does it work at 200% zoom? On mobile screens?
- Cognitive Load Review: Is there any way to simplify this further?
- Error Message Audit: Are errors in plain English with actionable fixes?
Reviewers should ask:
- Anxiety Check: "Could this interaction cause panic/stress for a neurodivergent user?"
- Clarity Check: "Is this UI element's purpose instantly obvious?"
- Undo Check: "Can the user reverse this action if they change their mind?"
- Feedback Check: "Does the user get immediate visual/audio confirmation?"
- Consistency Check: "Does this match existing patterns, or introduce new complexity?"
When choosing between two approaches:
❓ Which option has fewer clicks?
❓ Which option is more predictable?
❓ Which option provides clearer feedback?
❓ Which option is easier to undo?
❓ Which option reduces cognitive load?
✅ Choose that one.
We maintain a panel of neurodivergent testers (ADHD, dyslexia, autism) who review major UX changes. To request a review:
- Open PR with
[UX-REVIEW]tag - Fill out UX Impact Template (auto-added)
- Panel provides feedback within 48 hours
- Iterate based on feedback before merge
Panel Members (as of March 2026):
- Lyndz Williams (ADHD + Dyslexia) - Founder
- [Open for volunteers - see CONTRIBUTING.md]
❌ NEVER:
- Auto-play videos/sounds (sensory overload)
- Flash animations (seizure risk + distraction)
- Time-limited actions without extensions (anxiety trigger)
- Hidden "gotchas" or unexpected behavior (trust erosion)
- Walls of text without structure (dyslexia barrier)
- Low-contrast "modern" aesthetics (accessibility failure)
- Tooltips that disappear on hover (motor control issues)
- Complex multi-step forms without progress indicators (ADHD overwhelm)
✅ ALWAYS:
- Provide undo for everything
- Show clear progress indicators
- Use consistent patterns across the app
- Give instant feedback on actions
- Offer keyboard shortcuts for power users
- Include plain-English explanations
- Test with actual neurodivergent users
All docs must follow the ADHD-Friendly Format:
## Clear Heading (Action-Oriented)
**What This Does**: One-sentence summary.
**Why It Matters**: One-sentence reason.
### Step-by-Step
1. 🟢 **Low Risk**: Do this first.
2. 🟡 **Medium Risk**: This changes things.
3. 🔴 **High Risk**: Backup before doing this.
### Quick Example
```bash
# Copy-paste ready command
hypercode action --flag value- ❌ Error X: Means Y. Fix with Z.
- ❌ Error A: Means B. Fix with C.
- 💬 Discord: [Link]
- 📖 Full Docs: [Link]
**Key Elements**:
- Emoji visual cues (🟢🟡🔴)
- Short sentences (<20 words)
- Clear headings every 3-5 lines
- Code examples ready to copy
- No jargon without definitions
- Generous whitespace
---
## Agent X: The Meta-Architect 🦅
Agent X is a meta-agent system designed to architect, implement, and deploy specialized AI agents within the HyperCode ecosystem. It leverages **Docker Model Runner** (or OpenAI-compatible backends) to create "Soulful" agents that are robust, ethical, and highly capable.
---
## ⚡ Quick Start
Get the entire ecosystem running in **under 2 minutes** with **Hyper Station**.
> **New:** HyperCode now features an **Evolutionary Pipeline** that allows agents to upgrade themselves autonomously! See [docs/guides/EVOLUTIONARY_PIPELINE_SETUP.md](docs/guides/EVOLUTIONARY_PIPELINE_SETUP.md) to learn more.
### Prerequisites
- Docker Desktop
- Windows PowerShell
### Installation
1. **Clone the repository**
```powershell
git clone https://github.com/welshDog/HyperCode-V2.0.git
cd HyperCode-V2.0
-
Configure Environment
cp .env.example .env # Edit .env and add your API keys (Anthropic/OpenAI) -
Install Shortcuts (Recommended) Run the setup script to create Desktop shortcuts for one-click launch:
.\scripts\install_shortcuts.ps1
This creates "HYPER STATION START" and "HYPER STATION STOP" on your Desktop.
-
Launch the Mission Double-click HYPER STATION START or run:
.\scripts\hyper-station-start.bat
Once launched, the system opens automatically. You can also access services manually:
- 🚀 Mission Control Dashboard:
http://localhost:8088(Main Interface) - 🖥️ BROski Terminal:
http://localhost:3000(Command Line UI) - 🧠 Crew Orchestrator:
http://localhost:8081(Agent Management) - ❤️ Healer Agent:
http://localhost:8008(Self-Healing System) - 📝 Core API Docs:
http://localhost:8000/docs - 📊 Grafana:
http://localhost:3001(credentials viaGF_SECURITY_ADMIN_USER/GF_SECURITY_ADMIN_PASSWORD; see.env.example)
See docs/index.md for full documentation.
See HyperCode V2.0 in action with full observability:
Full gallery with 10+ dashboards: View Screenshot Gallery
- 🧠 Agent Intelligence: Real-time CPU tracking for all agents
- 🖥️ Node Exporter: System health + resource utilization
- 🌐 Mission Control: Network, disk I/O, Prometheus health
- 🧬 HyperSwarm: Agent heartbeat heatmaps + swarm status
- 🎨 HyperFocus Zone: MinIO S3 storage metrics
- ✅ 100% Uptime: All services healthy, 0 OOM kills
Quick, actionable guides for common tasks — built for neurodivergent minds!
🚀 Browse All Tips & Tricks (35 guides planned)
- ✅ Git Commit SHA Guide — What SHAs are + how to use them safely
- ✅ Git Basics — Clone, commit, push, pull explained
- 🔄 Agent Debugging, Docker Troubleshooting, Grafana Dashboards, Performance Tips, and more!
Every guide features:
- 🟢🟡🔴 Color-coded risk levels
- Step-by-step workflows (no walls of text)
- Real HyperCode examples
- ADHD/Dyslexia friendly format
See docs/architecture/architecture.md for detailed system design.
- HyperCode Core: FastAPI backend managing memory, context, and integrations.
- Crew Orchestrator: Manages the lifecycle and task execution of AI agents.
- The Brain: Cognitive core powered by Perplexity AI.
- DevOps Engineer: Handles CI/CD and Autonomous Evolution (rebuilding agents on-the-fly).
- Healer Agent: Monitors system health and automatically recovers failed services.
- Dashboard: Next.js/React frontend for real-time visualization and control.
- Infrastructure: Docker Compose network with Redis, PostgreSQL, and Observability stack.
Check the latest system health report: docs/notes/HyperCode_Health_Check_Report_2026-02-28.md
-
Architecture Overview - Deep dive into the system design.
-
CLI Manual - How to use the
hypercodecommand. -
Deployment Guide - Docker setup and configuration.
-
API Reference - Endpoints and usage.
-
Developer Onboarding - Join the swarm!
-
Troubleshooting - Fix common issues.
-
Tips & Tricks - Quick guides for common tasks.
We welcome contributions! Please see CONTRIBUTING.md for details.
Neurodivergent contributors especially welcome. See Contributor Guidelines above for how we maintain accessibility standards.
This policy describes how Generative AI (GenAI) tools (e.g. large language models, code assistants, chat-based coding copilots) may be used within the HyperCode project and how such use must be disclosed.
- Project scope: This policy applies to all HyperCode repositories, submodules, agents, and related tooling maintained under the HyperCode V2.0 ecosystem.
- Contributor scope: It applies to all contributors, whether core maintainers, occasional contributors, or automated agents acting on behalf of maintainers.
- Content scope: It covers all project artefacts, including source code, configuration, tests, documentation, examples, and generated assets where GenAI influenced the result.
- Tool scope: It specifically regulates the use of Generative AI (LLMs, code assistants, chatbots, etc.) and does not restrict deterministic code generation, formal methods, or non-GenAI automation.
This policy is grounded in the principles used by NLnet for GenAI in funded projects.
- Free/Libre/Open Source (FLOS): All outputs must remain compatible with recognised free and open-source licences; GenAI-assisted outputs must not introduce incompatible or copyrighted material.
- No misrepresentation: Contributors must not present AI-generated content as if it were fully human-authored work; human authorship and AI assistance must be clearly distinguishable.
- Human responsibility: Human contributors remain fully responsible for correctness, clarity, and reproducibility of all project outputs, including those assisted by GenAI.
- Transparency: Substantive use of GenAI that materially affects project outputs must be clearly disclosed and traceable for users, auditors, and other contributors.
The following uses of GenAI are allowed, provided they are disclosed according to this policy:
- Code assistance: Generating boilerplate, scaffolding, tests, or refactoring suggestions for project code.
- Documentation support: Drafting or restructuring documentation, comments, tutorials, or examples.
- Testing and analysis: Generating test cases, fuzz ideas, or static analysis suggestions using GenAI.
- Design exploration: Producing alternative designs, pseudo-code, or API sketches that are later refined by humans.
- Pure AI deliverables: Outcomes that are purely generated by AI, without substantial human intellectual contribution, must not be submitted as work products treated as human-authored deliverables (e.g. milestones for payment in NLnet-funded work).
- Hidden AI authorship: It is not permitted to use GenAI to produce project artefacts and then present them as purely human work.
- Unvetted code: AI-generated code must not be merged or released without human review and understanding of the changes.
- Terms of use conflicts: GenAI tools must not be used if their terms of service risk introducing copyrighted or licence-incompatible content into the project.
All contributors using GenAI for HyperCode have the following responsibilities:
- Attribution and disclosure: Clearly indicate where GenAI was used, including the model name, version (where known), and the nature of the assistance.
- Provenance tracking: Maintain a record (commit message, issue, or log file) that links AI-generated segments to the prompts and outputs used, or a concise summary thereof.
- Human validation: Review and, where necessary, edit AI outputs so that you can explain and justify the design and code decisions.
- Licensing checks: Verify that AI outputs do not reproduce incompatible or copyrighted material and remain suitable for FLOS licensing.
At repository level, HyperCode maintains this AI Disclosure Policy section in the README to document:
- Whether and how GenAI is used in the project (e.g. for logic, boilerplate, tests, documentation, etc.).
- Expectations and rules for contributors when using GenAI.
If a particular sub-project or component follows stricter rules, that should be documented in its local README, referencing this policy.
For any substantive use of GenAI that materially affects project outputs (code, tests, or documentation), the responsible contributor must:
- Use the project’s
.gitmessagetemplate (see below) when committing. - Include, in the commit message:
- A short human-readable description of the change.
- An AI Disclosure block specifying:
- Model name and provider (e.g.
gpt-5.1 (Perplexity)), - Estimated percentage of the diff generated or heavily influenced by GenAI,
- A brief description of how GenAI was used (e.g. “generated initial test file”, “suggested refactor”),
- Confirmation that a human reviewed and validated the changes.
- Model name and provider (e.g.
Generated content should be clearly marked as such in the commit message, and where practical, in code comments near large AI-generated blocks.
If GenAI is used only for:
- Brainstorming,
- High-level design discussions, or
- Minor edits to wording in documentation,
then a high-level statement in the commit message (e.g. “Doc phrasing adjusted with GenAI assistance”) is sufficient, as long as the overall stance is clear in the README.
Before merging or submitting work that involved GenAI, verify the following:
- FLOS compatibility
- I have checked that no AI output introduces non-free or incompatible licensing issues.
- Attribution & transparency
- I have clearly marked AI-assisted content and included an AI Disclosure block in my commit message where applicable.
- Human responsibility
- I understand the code/content produced and can explain any design or implementation decisions.
- Provenance
- I have recorded the GenAI model and its usage (and prompts, where relevant) in a durable place (commit message, issue, or internal log).
- Quality
- Use of GenAI has not reduced the clarity, reliability, or reproducibility of the work.
- Policy alignment
- My use of GenAI is consistent with NLnet’s Generative AI policy and this project’s AI Disclosure Policy.
Failure to follow this policy may lead to rejection of contributions in this project and, where NLnet funding is involved, may contribute to non-compliance with NLnet’s GenAI policy.
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).
This means:
- ✅ You can use, modify, and distribute this software freely
- ✅ Commercial use is allowed
⚠️ If you run this as a network service (API, web app, etc.), you must open-source your modifications- 🛡️ Protects the neurodivergent-first mission from corporate paywalling
See the LICENSE file for full legal details.
- 💬 Discord: Join the HyperFocus Zone - Safe space for neurodivergent devs
- 🐦 Twitter/X: @welshDog
- 💰 Sponsor: GitHub Sponsors - Help keep this free and accessible
- 📧 Email: lyndz@hyperfocus.zone
Remember: A BROski is ride or die. We build this together. 🐶♾️🔥
