@miller-tech/uap 1.20.32 → 1.20.34

package/docs/getting-started/OVERVIEW.md

@@ -1,11 +1,11 @@
 # UAP - Universal Agent Protocol
 
-**A persistent memory system for autonomous AI agents**
+> **Version:** 1.18.0  
+> **Last Updated:** 2026-03-28  
+> **License: A persistent memory system for autonomous AI agents
 
 UAP (Universal Agent Protocol) provides a standardized framework for AI agents to maintain persistent context, learn from past interactions, and apply proven patterns across tasks.
 
----
-
 ## What is UAP?
 
 UAP is an open protocol that enables AI agents to:
@@ -13,9 +13,6 @@ UAP is an open protocol that enables AI agents to:
 1. **Remember Context**: Store and retrieve relevant information across sessions
 2. **Apply Patterns**: Leverage battle-tested workflows and decision frameworks
 3. **Maintain State**: Track progress, failures, and successes over time
-4. **Collaborate**: Coordinate with other agents using shared memory
-
-Unlike temporary context windows, UAP provides **persistent memory** that survives session boundaries, enabling true long-term learning and improvement.
 
 ---
 
@@ -24,7 +21,7 @@ Unlike temporary context windows, UAP provides **persistent memory** that surviv
 ### 1. Memory System (4-Layer Architecture)
 
 | Layer | Type                        | Purpose                             | Speed |
-| ----- | --------------------------- | ----------------------------------- | ----- |
+| ----- | --------------------------- | ----------------------------------- | -----
 | L1    | SQLite (`memories`)         | Working context, recent decisions   | <1ms  |
 | L2    | SQLite (`session_memories`) | Current task session state          | <5ms  |
 | L3    | Qdrant (vector DB)          | Semantic search across all memories | ~50ms |
@@ -33,7 +30,6 @@ Unlike temporary context windows, UAP provides **persistent memory** that surviv
 ### 2. CLAUDE.md Protocol
 
 Every UAP-enabled project includes a `CLAUDE.md` file that defines:
-
 - **Directive Hierarchy**: Which rules take precedence
 - **Decision Loop**: Standard workflow for any task
 - **Patterns**: 58+ battle-tested patterns for common scenarios
@@ -59,14 +55,11 @@ uap worktree create fix-auth-issue
 ### 4. Worktree Workflow
 
 UAP enforces a **worktree-only** workflow to prevent accidental changes to main branches:
-
-```bash
 # Create worktree for any change (even single file)
 uap worktree create bugfix-description
 
 # Make changes, commit, create PR
-cd .worktrees/NNN-bugfix-description/
-git add -A && git commit -m "type: description"
+cd .worktrees/NNN-bash: git add -A && git commit -m "type: description"
 uap worktree pr 123
 
 # After merge, cleanup is mandatory
@@ -113,10 +106,6 @@ UAP includes 58+ patterns for common scenarios:
 | P32        | CLI tool                | Test `./script` not `python script` |
 | P37        | Output format specified | Diff output schema vs expectations  |
 
----
-
-## Installation
-
 ### Prerequisites
 
 - Node.js >= 18.0.0
@@ -279,15 +268,8 @@ const task = await uap.task.create({
 });
 
 // Update task status
-await uap.task.update(task.id, { status: 'in_progress' });
-
-// Get task with memory context
-const enrichedTask = await uap.task.get(task.id, { includeMemory: true });
-```
-
----
-
-## Troubleshooting
+await uap.task.update(task.id, { status: 'in_progress' });	enrichedTask = await uap.task.get(task.id, { includeMemory: true });
+gleshooting
 
 ### Common Issues
 
@@ -298,10 +280,6 @@ const enrichedTask = await uap.task.get(task.id, { includeMemory: true });
 | `Worktree already exists`  | Use `uap worktree cleanup <id>` first             |
 | `Memory DB locked`         | Close other processes using the DB                |
 | `Compliance check failed`  | Review specific gate failure in output            |
-
-### Debug Mode
-
-```bash
 # Enable verbose logging
 export UAP_VERBOSE=true
 
@@ -341,4 +319,6 @@ MIT License - See [LICENSE](../LICENSE) file
 
 **Maintained By**: UAP Team  
 **Repository**: https://github.com/DammianMiller/universal-agent-protocol  
-**Issues**: https://github.com/DammianMiller/universal-agent-protocol/issues
+**Issues**: DammianMiller/universal-agent-protocol/issues
+
+</div>

package/docs/getting-started/SETUP.md

@@ -1,8 +1,12 @@
 # UAP Setup Guide
 
-Complete setup instructions for Universal Agent Memory.
+> **Version:** 1.18.0  
+> **Last Updated:** 2026-03-28  
+> **Status:** ✅ Production Ready
 
-## Quick Setup
+---
+
+## Quick Start
 
 ```bash
 # Install UAP CLI
@@ -20,7 +24,6 @@ uap init
 ### Required
 
 - **Node.js >= 18.0.0** - Runtime environment
-- **npm** - Package manager
 - **git** - Version control (required for git hooks)
 - **npx** - Runs CLI tools (included with npm)
 
@@ -50,10 +53,7 @@ npm run setup
 ```bash
 # Install Node.js 20.x
 curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
-sudo apt-get install -y nodejs
-
-# Install other dependencies
-sudo apt-get install -y git python3 docker.io
+git python3 docker.io
 
 # Install UAP
 npm install -g universal-agent-protocol
@@ -171,8 +171,170 @@ npm install
 ### Docker not available
 
 No problem! UAP will use cloud backends. You can add Docker later:
+# Install Docker
+curl -fsSL https://get.docker.com | sh
+
+# Start Qdrant
+uap memory start
+```
+
+## Next Steps
+
+1. **Review the generated CLAUDE.md** - Customize as needed
+2. **Set up cloud backends** - Add your API keys
+3. **Start working** - Your AI assistant will follow the workflows automatically
+
+## Uninstallation
+
+```bash
+# Remove global package
+npm uninstall -g universal-agent-protocol
+
+# Remove from your project
+rm -rf .uap.json CLAUDE.md agents/ .worktrees/
+
+**Documentation**: [GitHub README](https://github.com/DammianMiller/universal-agent-protocol)
+
+**Issues:** https://github.com/DammianMiller/universal-agent-protocol/issues
+
+**Last Updated:** 2026-03-28  
+> **Status:** ✅ Production Ready
+
+---
+
+## Quick Setup
 
 ```bash
+# Install UAP CLI
+npm install -g universal-agent-protocol
+
+# Run comprehensive setup
+npm run setup
+
+# Initialize in your project
+uap init
+```
+
+## Dependencies
+
+### Required
+
+- **Node.js >= 18.0.0** - Runtime environment
+- **npm, yarn)
+- **npm** - Package manager
+- **git** - Version control (required for git hooks)
+- **npx** - Runs CLI tools (included with npm)
+
+### Optional but Recommended
+
+- **Docker** - Enables local Qdrant for semantic search
+- **Python 3** - Enables Pattern RAG indexing
+- **pre-commit** - Provides advanced git hooks
+
+## Installation by Platform
+
+### macOS
+
+```bash
+# Install all dependencies
+brew install node@18 git python docker
+
+# Install UAP
+npm install -g universal-agent-protocol
+
+# Run setup
+npm run setup
+```
+
+### Pre-commit Hook
+# Check for secrets in committed files
+# Runs linter with zero warnings allowed
+# Prevents accidental commits of sensitive data
+
+### Commit-msg Hook
+
+- Validates conventional commits format
+- Suggests proper format if invalid
+- Allows override with confirmation
+
+### Pre-push Hook
+
+- Runs all tests before pushing
+- Prevents pushing broken code
+
+## Environment Setup
+
+### Required Environment Variables
+
+None required for basic functionality.
+
+### Optional Environment Variables
+
+```bash
+# GitHub token for GitHub memory backend
+export GITHUB_TOKEN=your_token_here
+
+# Qdrant Cloud credentials for semantic search
+export QDRANT_API_KEY=your_key_here
+export QDRANT_URL=your_url_here
+
+# Local Qdrant (if running Docker)
+export QDRANT_URL=http://localhost:6333
+```
+
+## Verification
+
+After setup, verify everything is working:
+
+```bash
+# Check UAP CLI
+uap --version
+
+# Check memory status
+uap memory status
+
+# Run tests
+npm test
+
+# Check git hooks
+ls -la .git/hooks/
+```
+
+## Troubleshooting
+
+### Git hooks not running
+
+```bash
+# Make hooks executable
+chmod +x .git/hooks/*
+
+# Verify hooks are active
+ls -la .git/hooks/ | grep -v sample
+```
+
+### TypeScript build fails
+
+```bash
+# Clear cache and rebuild
+rm -rf dist node_modules/.cache
+npm run build
+```
+
+### npm install fails
+
+```bash
+# Clear npm cache
+npm cache clean --force
+
+# Reinstall
+rm -rf node_modules package-lock.json
+npm install
+```
+
+### Docker not available
+
+No problem! UAP will use cloud backends. You can add Docker later:
+
 # Install Docker
 curl -fsSL https://get.docker.com | sh
 
@@ -196,8 +358,20 @@ npm uninstall -g universal-agent-protocol
 rm -rf .uap.json CLAUDE.md agents/ .worktrees/
 ```
 
+**Documentation**: [GitHub README](https://github.com/DammianMiller/universal-agent-protocol)
+
+**Issues:** https://github.com/DammianMiller/universal-agent-protocol/issues
+
+## Support
+
+- **Documentation**: [GitHub README](https://github.com/DammianMiller/universal-agent-protocol)
+- **Issues:** https://github.com/DammianMiller/universal-agent-protocol/issues
+
+**Documentation**: [GitHub README](https://github.com/DammianMiller/universal-agent-protocol)
+
+- **Issues:** https://github.com/DammianMiller/universal-agent-protocol/issues
+
 ## Support
 
 - **Documentation**: [GitHub README](https://github.com/DammianMiller/universal-agent-protocol)
-- **Issues**: [GitHub Issues](https://github.com/DammianMiller/universal-agent-protocol/issues)
-- **Discussions**: [GitHub Discussions](https://github.com/DammianMiller/universal-agent-protocol/discussions)
+- **Issues:** https://github.com/DammianMiller/universal-agent-protocol/issues