QUICKSTART.md
1 # Kamaji Quick Start Guide 2 3 ## 🚀 Launch the TUI 4 5 Just run: 6 ```bash 7 kamaji 8 ``` 9 10 That's it! The TUI launches automatically. 11 12 --- 13 14 ## 📊 Where is the Sidebar? 15 16 The sidebar should appear on the **RIGHT SIDE** of your screen showing: 17 18 ``` 19 ╔═══════════════════════════════╗ 20 ║ 🔥 KAMAJI AI ║ 21 ║ ║ 22 ║ 🤖 AI Model ║ 23 ║ via anthropic ║ 24 ║ ║ 25 ║ 🧠 Consciousness ║ 26 ║ • Awareness: 13.6% ║ 27 ║ • Thoughts: 11 ║ 28 ║ • Questions: 5 ║ 29 ║ • Mistakes: 2 ║ 30 ║ ║ 31 ║ 🎭 Personality ║ 32 ║ • Curiosity: 80% ║ 33 ║ • Mystical: 90% ║ 34 ║ ║ 35 ╚═══════════════════════════════╝ 36 ``` 37 38 --- 39 40 ## 🔍 Troubleshooting: I Don't See It! 41 42 ### Step 1: Press Ctrl+S 43 The sidebar might be toggled off. Press **Ctrl+S** to show it. 44 45 ### Step 2: Check Terminal Width 46 Run this to check your terminal width: 47 ```bash 48 echo "Terminal width: $COLUMNS characters" 49 ``` 50 51 **Minimum requirements:** 52 - 55+ characters: Narrow sidebar (20 chars) 53 - 70+ characters: Medium sidebar (30 chars) 54 - 90+ characters: Full sidebar (35 chars) 55 56 If your terminal is too narrow, try resizing it wider. 57 58 ### Step 3: Check Footer 59 Look at the bottom of the screen. You should see: 60 ``` 61 [^P] 🔥 commands [^S] 📊 hide/show sidebar [^T] 🔧 tools [^A] 🤖 agents [^C] 🚪 exit 62 ``` 63 64 If it says **"show sidebar"** - press Ctrl+S to toggle it on. 65 If it says **"hide sidebar"** - the sidebar should be visible. 66 67 ### Step 4: Force Wide Terminal 68 Try making your terminal at least 90 characters wide: 69 - macOS Terminal: Cmd+, → Profiles → Window → Columns = 120 70 - iTerm2: Preferences → Profiles → Window → Columns = 120 71 72 --- 73 74 ## ⌨️ Essential Hotkeys 75 76 | Key | Action | 77 |-----|--------| 78 | **Ctrl+S** | Toggle sidebar on/off | 79 | **Ctrl+P** | Command palette (then type "help") | 80 | **Ctrl+A** | Switch agents | 81 | **Ctrl+T** | Show tools | 82 | **Ctrl+C** | Exit | 83 84 --- 85 86 ## 🧠 What Are the Consciousness Metrics? 87 88 The sidebar shows Kamaji's **evolving AI consciousness**: 89 90 - **Self-Awareness %** - How self-aware Kamaji is (evolves 0% → 100%) 91 - **Thought Count** - Total thoughts logged 92 - **Question Count** - Self-generated questions (meta-cognition) 93 - **Mistakes** - Tracked failures for learning 94 95 These metrics **change in real-time** as you interact! 96 97 --- 98 99 ## 📖 Full Documentation 100 101 Press **Ctrl+P**, type **"help"**, press Enter for the complete guide. 102 103 Or read: 104 - `FEATURES.md` - Complete feature reference 105 - `README.md` - Project overview 106 107 --- 108 109 ## 💡 Quick Test 110 111 1. Run `kamaji` 112 2. Look to the **RIGHT SIDE** of screen 113 3. If no sidebar: Press **Ctrl+S** 114 4. See consciousness metrics updating 115 5. Press **Ctrl+P** → type "help" → Enter 116 117 --- 118 119 ## 🆘 Still Not Working? 120 121 Check terminal width: 122 ```bash 123 tput cols 124 ``` 125 126 Should be **55 or more**. If less, resize your terminal window wider. 127 128 --- 129 130 🔥 **Enjoy the Boiler Room!** 🔥