@bonginkan/maria 1.6.6 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/COMMANDS.md +177 -0
- package/GETTING_STARTED.md +183 -0
- package/README.md +165 -206
- package/SETUP.md +236 -0
- package/bin/maria +21 -13
- package/package.json +51 -5
package/COMMANDS.md
ADDED
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
# 📋 MARIA Platform Command Reference
|
|
2
|
+
|
|
3
|
+
Complete reference for all 36+ interactive slash commands in MARIA Platform v1.6.4
|
|
4
|
+
|
|
5
|
+
## 🚀 How to Use Commands
|
|
6
|
+
|
|
7
|
+
All commands in MARIA are **slash commands** used within interactive mode:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# Start MARIA interactive mode
|
|
11
|
+
maria
|
|
12
|
+
|
|
13
|
+
# Use slash commands within MARIA
|
|
14
|
+
> /command_name [options]
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## 🎓 Algorithm Education Commands
|
|
18
|
+
|
|
19
|
+
### Sorting Algorithms
|
|
20
|
+
| Command | Description | Options | Example |
|
|
21
|
+
|---------|-------------|---------|---------|
|
|
22
|
+
| `/sort quicksort` | Interactive quicksort tutorial | `--visualize`, `--benchmark` | `/sort quicksort --visualize` |
|
|
23
|
+
| `/sort mergesort` | Interactive merge sort tutorial | `--visualize`, `--benchmark` | `/sort mergesort --benchmark` |
|
|
24
|
+
| `/sort heapsort` | Interactive heap sort tutorial | `--visualize`, `--benchmark` | `/sort heapsort` |
|
|
25
|
+
| `/sort bubblesort` | Interactive bubble sort tutorial | `--visualize` | `/sort bubblesort --visualize` |
|
|
26
|
+
| `/sort insertionsort` | Interactive insertion sort tutorial | `--visualize` | `/sort insertionsort` |
|
|
27
|
+
|
|
28
|
+
### Learning & Analysis
|
|
29
|
+
| Command | Description | Options | Example |
|
|
30
|
+
|---------|-------------|---------|---------|
|
|
31
|
+
| `/learn algorithms` | Complete CS curriculum | `--topic [name]` | `/learn algorithms --topic sorting` |
|
|
32
|
+
| `/algorithm complexity` | Big O notation tutorials | `--algorithm [name]` | `/algorithm complexity --algorithm quicksort` |
|
|
33
|
+
| `/benchmark sorting` | Performance analysis | `--size [n]`, `--iterations [n]` | `/benchmark sorting --size 10000` |
|
|
34
|
+
| `/analyze performance` | Memory and time analysis | `--algorithm [name]` | `/analyze performance --algorithm mergesort` |
|
|
35
|
+
|
|
36
|
+
## 🤖 AI Development Commands
|
|
37
|
+
|
|
38
|
+
### Code Generation
|
|
39
|
+
| Command | Description | Options | Example |
|
|
40
|
+
|---------|-------------|---------|---------|
|
|
41
|
+
| `/code "description"` | AI code generation | `--language [lang]`, `--style [style]` | `/code "REST API" --language python` |
|
|
42
|
+
| `/generate function` | Generate specific functions | `--type [type]`, `--complexity [level]` | `/generate function --type sorting` |
|
|
43
|
+
| `/implement algorithm` | Implement algorithms | `--language [lang]`, `--optimize` | `/implement algorithm --language typescript` |
|
|
44
|
+
| `/refactor code` | Refactor existing code | `--style [style]`, `--optimize` | `/refactor code --optimize` |
|
|
45
|
+
|
|
46
|
+
### Code Quality & Analysis
|
|
47
|
+
| Command | Description | Options | Example |
|
|
48
|
+
|---------|-------------|---------|---------|
|
|
49
|
+
| `/bug analyze` | Bug detection and fixes | `--file [path]`, `--severity [level]` | `/bug analyze --file src/app.js` |
|
|
50
|
+
| `/lint check` | Code quality analysis | `--fix`, `--rules [ruleset]` | `/lint check --fix` |
|
|
51
|
+
| `/security review` | Security vulnerability scan | `--level [level]` | `/security review --level strict` |
|
|
52
|
+
| `/performance profile` | Performance profiling | `--type [type]` | `/performance profile --type memory` |
|
|
53
|
+
|
|
54
|
+
## 🧠 AI Model & Mode Commands
|
|
55
|
+
|
|
56
|
+
### Model Management
|
|
57
|
+
| Command | Description | Options | Example |
|
|
58
|
+
|---------|-------------|---------|---------|
|
|
59
|
+
| `/model` | AI model selection | `--provider [name]`, `--list` | `/model --provider openai` |
|
|
60
|
+
| `/model list` | Show available models | `--provider [name]` | `/model list --provider anthropic` |
|
|
61
|
+
| `/model switch` | Switch AI model | `--to [model_name]` | `/model switch --to gpt-4` |
|
|
62
|
+
| `/model config` | Configure model settings | `--temperature [n]`, `--max-tokens [n]` | `/model config --temperature 0.7` |
|
|
63
|
+
|
|
64
|
+
### Cognitive Modes
|
|
65
|
+
| Command | Description | Options | Example |
|
|
66
|
+
|---------|-------------|---------|---------|
|
|
67
|
+
| `/mode internal` | Access 50 cognitive AI modes | `--list`, `--mode [name]` | `/mode internal --mode debugging` |
|
|
68
|
+
| `/mode list` | List all cognitive modes | `--category [type]` | `/mode list --category creative` |
|
|
69
|
+
| `/mode switch` | Switch cognitive mode | `--to [mode_name]` | `/mode switch --to optimizing` |
|
|
70
|
+
| `/thinking mode` | Enter thinking mode | `--depth [level]` | `/thinking mode --depth deep` |
|
|
71
|
+
|
|
72
|
+
## 🔧 System & Utility Commands
|
|
73
|
+
|
|
74
|
+
### System Management
|
|
75
|
+
| Command | Description | Options | Example |
|
|
76
|
+
|---------|-------------|---------|---------|
|
|
77
|
+
| `/status` | System status and health | `--detailed`, `--services` | `/status --detailed` |
|
|
78
|
+
| `/config` | Configuration management | `--set [key=value]`, `--get [key]` | `/config --set theme=dark` |
|
|
79
|
+
| `/update` | Check for updates | `--install`, `--check` | `/update --check` |
|
|
80
|
+
| `/reset` | Reset MARIA settings | `--confirm`, `--keep-models` | `/reset --keep-models` |
|
|
81
|
+
|
|
82
|
+
### Help & Information
|
|
83
|
+
| Command | Description | Options | Example |
|
|
84
|
+
|---------|-------------|---------|---------|
|
|
85
|
+
| `/help` | Show all commands | `--category [name]`, `--search [term]` | `/help --category algorithm` |
|
|
86
|
+
| `/docs` | Access documentation | `--topic [name]`, `--search [term]` | `/docs --topic quicksort` |
|
|
87
|
+
| `/examples` | Show command examples | `--command [name]` | `/examples --command sort` |
|
|
88
|
+
| `/tutorial` | Interactive tutorials | `--topic [name]`, `--level [level]` | `/tutorial --topic algorithms` |
|
|
89
|
+
|
|
90
|
+
### Session Management
|
|
91
|
+
| Command | Description | Options | Example |
|
|
92
|
+
|---------|-------------|---------|---------|
|
|
93
|
+
| `/history` | Command history | `--search [term]`, `--clear` | `/history --search sort` |
|
|
94
|
+
| `/save session` | Save current session | `--name [name]` | `/save session --name my_work` |
|
|
95
|
+
| `/load session` | Load saved session | `--name [name]`, `--list` | `/load session --name my_work` |
|
|
96
|
+
| `/clear` | Clear screen | `--history`, `--all` | `/clear --history` |
|
|
97
|
+
| `/exit` | Exit MARIA | `--save`, `--force` | `/exit --save` |
|
|
98
|
+
|
|
99
|
+
## 🚀 Advanced Features
|
|
100
|
+
|
|
101
|
+
### Multi-Agent Commands
|
|
102
|
+
| Command | Description | Options | Example |
|
|
103
|
+
|---------|-------------|---------|---------|
|
|
104
|
+
| `/agent create` | Create autonomous agent | `--task [description]` | `/agent create --task "build API"` |
|
|
105
|
+
| `/agent list` | List active agents | `--status [status]` | `/agent list --status active` |
|
|
106
|
+
| `/agent stop` | Stop agent execution | `--id [agent_id]` | `/agent stop --id agent_123` |
|
|
107
|
+
| `/orchestrate` | Multi-agent coordination | `--agents [list]` | `/orchestrate --agents "dev,test,deploy"` |
|
|
108
|
+
|
|
109
|
+
### Integration Commands
|
|
110
|
+
| Command | Description | Options | Example |
|
|
111
|
+
|---------|-------------|---------|---------|
|
|
112
|
+
| `/git integrate` | Git integration | `--status`, `--commit [message]` | `/git integrate --status` |
|
|
113
|
+
| `/project analyze` | Project analysis | `--deep`, `--report` | `/project analyze --deep` |
|
|
114
|
+
| `/export results` | Export session results | `--format [type]`, `--file [path]` | `/export results --format json` |
|
|
115
|
+
|
|
116
|
+
## 💡 Usage Tips
|
|
117
|
+
|
|
118
|
+
### Command Shortcuts
|
|
119
|
+
- Use **Tab completion** for command names and options
|
|
120
|
+
- **Up/Down arrows** to navigate command history
|
|
121
|
+
- **Ctrl+C** to cancel current operation
|
|
122
|
+
- **Ctrl+L** to clear screen (same as `/clear`)
|
|
123
|
+
|
|
124
|
+
### Option Patterns
|
|
125
|
+
- `--help` works with any command for detailed help
|
|
126
|
+
- `--verbose` or `-v` for detailed output
|
|
127
|
+
- `--quiet` or `-q` for minimal output
|
|
128
|
+
- `--dry-run` to preview actions without executing
|
|
129
|
+
|
|
130
|
+
### Combining Commands
|
|
131
|
+
```bash
|
|
132
|
+
# Chain operations
|
|
133
|
+
> /sort quicksort --visualize && /benchmark sorting
|
|
134
|
+
|
|
135
|
+
# Use command output
|
|
136
|
+
> /model list --provider openai | /config --set preferred-model
|
|
137
|
+
|
|
138
|
+
# Save and reuse
|
|
139
|
+
> /save session --name algo_learning
|
|
140
|
+
> /tutorial --topic sorting && /save session --name algo_complete
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## 🔍 Command Categories
|
|
144
|
+
|
|
145
|
+
### 🎓 Education (8 commands)
|
|
146
|
+
`/sort`, `/learn`, `/algorithm`, `/benchmark`, `/analyze`, `/tutorial`, `/examples`, `/docs`
|
|
147
|
+
|
|
148
|
+
### 🤖 AI Development (10 commands)
|
|
149
|
+
`/code`, `/generate`, `/implement`, `/refactor`, `/model`, `/mode`, `/thinking`, `/bug`, `/lint`, `/security`
|
|
150
|
+
|
|
151
|
+
### 🔧 System (8 commands)
|
|
152
|
+
`/status`, `/config`, `/update`, `/reset`, `/help`, `/history`, `/clear`, `/exit`
|
|
153
|
+
|
|
154
|
+
### 🚀 Advanced (6 commands)
|
|
155
|
+
`/agent`, `/orchestrate`, `/git`, `/project`, `/export`, `/performance`
|
|
156
|
+
|
|
157
|
+
### 💾 Session (4 commands)
|
|
158
|
+
`/save`, `/load`, `/history`, `/clear`
|
|
159
|
+
|
|
160
|
+
## 🆘 Getting Help
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
# General help
|
|
164
|
+
> /help
|
|
165
|
+
|
|
166
|
+
# Help for specific command
|
|
167
|
+
> /sort --help
|
|
168
|
+
> /model --help
|
|
169
|
+
|
|
170
|
+
# Search help
|
|
171
|
+
> /help --search "algorithm"
|
|
172
|
+
|
|
173
|
+
# Show examples
|
|
174
|
+
> /examples --command code
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
**Total Commands: 36+ interactive slash commands for complete AI-powered development and algorithm education experience!**
|
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
# 🎯 Getting Started with MARIA Platform
|
|
2
|
+
|
|
3
|
+
Welcome to MARIA Platform v1.6.4 "Algorithm Education Revolution"! This guide will help you get up and running in minutes.
|
|
4
|
+
|
|
5
|
+
## 🚀 Quick Start (2 Minutes)
|
|
6
|
+
|
|
7
|
+
### Step 1: Install MARIA
|
|
8
|
+
```bash
|
|
9
|
+
npm install -g @bonginkan/maria
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
### Step 2: Verify Installation
|
|
13
|
+
```bash
|
|
14
|
+
maria --version
|
|
15
|
+
# Should output: MARIA Platform v1.6.4 "Algorithm Education Revolution"
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
### Step 3: Start Interactive Mode
|
|
19
|
+
```bash
|
|
20
|
+
maria
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
You should see the welcome screen with MARIA's beautiful ASCII logo and interactive prompt.
|
|
24
|
+
|
|
25
|
+
### Step 4: Try Your First Commands
|
|
26
|
+
```bash
|
|
27
|
+
# Within MARIA interactive mode:
|
|
28
|
+
> /help # See all available commands
|
|
29
|
+
> /sort quicksort --visualize # Try algorithm education
|
|
30
|
+
> /code "hello world function" # Generate code with AI
|
|
31
|
+
> /status # Check system status
|
|
32
|
+
> /exit # Exit when done
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
**Congratulations! 🎉 You're now ready to explore MARIA's full potential.**
|
|
36
|
+
|
|
37
|
+
## 🎓 Learning Paths
|
|
38
|
+
|
|
39
|
+
### For Computer Science Students
|
|
40
|
+
|
|
41
|
+
**Goal**: Learn algorithms and data structures interactively
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
maria
|
|
45
|
+
> /help # Overview of all commands
|
|
46
|
+
> /sort quicksort # Learn quicksort algorithm
|
|
47
|
+
> /sort mergesort # Learn merge sort
|
|
48
|
+
> /learn algorithms # Complete CS curriculum
|
|
49
|
+
> /benchmark sorting # Compare algorithm performance
|
|
50
|
+
> /algorithm complexity # Big O notation tutorials
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
**Daily Practice** (15 minutes):
|
|
54
|
+
1. Start with one algorithm: `/sort [algorithm_name]`
|
|
55
|
+
2. Study the implementation details
|
|
56
|
+
3. Try performance analysis: `/benchmark [algorithm_name]`
|
|
57
|
+
4. Practice with code generation: `/code "implement [algorithm]"`
|
|
58
|
+
|
|
59
|
+
### For Software Developers
|
|
60
|
+
|
|
61
|
+
**Goal**: AI-powered development assistance and code quality
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
maria
|
|
65
|
+
> /model # Configure preferred AI model
|
|
66
|
+
> /code "function description" # Generate code with AI
|
|
67
|
+
> /bug analyze # Bug detection and fixes
|
|
68
|
+
> /lint check # Code quality analysis
|
|
69
|
+
> /mode internal # Experience 50 cognitive AI modes
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
**Development Workflow**:
|
|
73
|
+
1. Start MARIA: `maria`
|
|
74
|
+
2. Set preferred AI model: `/model`
|
|
75
|
+
3. Use for coding tasks: `/code`, `/bug`, `/lint`
|
|
76
|
+
4. Leverage AI modes for different tasks
|
|
77
|
+
5. Learn algorithms for better coding: `/sort`, `/learn`
|
|
78
|
+
|
|
79
|
+
### For Educators
|
|
80
|
+
|
|
81
|
+
**Goal**: Teach computer science with interactive tools
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
maria
|
|
85
|
+
> /learn algorithms # Access full CS curriculum
|
|
86
|
+
> /sort quicksort --visualize # Interactive algorithm demos
|
|
87
|
+
> /algorithm complexity # Teach Big O notation
|
|
88
|
+
> /benchmark sorting # Show performance differences
|
|
89
|
+
> /help # Command reference for lessons
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
**Classroom Integration**:
|
|
93
|
+
1. Install MARIA on classroom computers
|
|
94
|
+
2. Create lesson plans using algorithm commands
|
|
95
|
+
3. Use visualization features for demonstrations
|
|
96
|
+
4. Assign interactive algorithm practice
|
|
97
|
+
5. Show real-world performance comparisons
|
|
98
|
+
|
|
99
|
+
## 🔧 Essential Commands Reference
|
|
100
|
+
|
|
101
|
+
### Algorithm Education
|
|
102
|
+
| Command | Description | Example |
|
|
103
|
+
|---------|-------------|---------|
|
|
104
|
+
| `/sort [algorithm]` | Interactive algorithm tutorial | `/sort quicksort` |
|
|
105
|
+
| `/learn algorithms` | Complete CS curriculum | `/learn algorithms` |
|
|
106
|
+
| `/benchmark [type]` | Performance analysis | `/benchmark sorting` |
|
|
107
|
+
| `/algorithm complexity` | Big O notation guide | `/algorithm complexity` |
|
|
108
|
+
|
|
109
|
+
### AI Development
|
|
110
|
+
| Command | Description | Example |
|
|
111
|
+
|---------|-------------|---------|
|
|
112
|
+
| `/code "description"` | AI code generation | `/code "REST API"` |
|
|
113
|
+
| `/bug analyze` | Bug detection | `/bug analyze` |
|
|
114
|
+
| `/lint check` | Code quality | `/lint check` |
|
|
115
|
+
| `/model` | AI model selection | `/model` |
|
|
116
|
+
|
|
117
|
+
### System & Help
|
|
118
|
+
| Command | Description | Example |
|
|
119
|
+
|---------|-------------|---------|
|
|
120
|
+
| `/help` | Show all commands | `/help` |
|
|
121
|
+
| `/status` | System status | `/status` |
|
|
122
|
+
| `/mode internal` | Cognitive AI modes | `/mode internal` |
|
|
123
|
+
| `/exit` | Exit MARIA | `/exit` |
|
|
124
|
+
|
|
125
|
+
## 🎯 First Week Challenge
|
|
126
|
+
|
|
127
|
+
### Day 1-2: Setup & Exploration
|
|
128
|
+
- Install MARIA
|
|
129
|
+
- Try all basic commands with `/help`
|
|
130
|
+
- Explore algorithm education with `/sort quicksort`
|
|
131
|
+
|
|
132
|
+
### Day 3-4: Algorithm Learning
|
|
133
|
+
- Learn 3 sorting algorithms: quicksort, mergesort, heapsort
|
|
134
|
+
- Compare their performance with `/benchmark`
|
|
135
|
+
- Understand complexity with `/algorithm complexity`
|
|
136
|
+
|
|
137
|
+
### Day 5-6: AI Development
|
|
138
|
+
- Configure AI model with `/model`
|
|
139
|
+
- Generate code with `/code` commands
|
|
140
|
+
- Try bug analysis and code quality tools
|
|
141
|
+
|
|
142
|
+
### Day 7: Advanced Features
|
|
143
|
+
- Explore 50 cognitive AI modes with `/mode internal`
|
|
144
|
+
- Try complex code generation tasks
|
|
145
|
+
- Share your experience with the community
|
|
146
|
+
|
|
147
|
+
## 💡 Pro Tips
|
|
148
|
+
|
|
149
|
+
1. **Command Memory**: Use `/help` frequently until you memorize commands
|
|
150
|
+
2. **Tab Completion**: Most terminals support tab completion for faster typing
|
|
151
|
+
3. **Copy & Paste**: Copy generated code directly from MARIA output
|
|
152
|
+
4. **Multiple Sessions**: You can run multiple MARIA instances simultaneously
|
|
153
|
+
5. **Learning Notes**: Keep a notebook of algorithms you've learned
|
|
154
|
+
|
|
155
|
+
## 🌟 What's Next?
|
|
156
|
+
|
|
157
|
+
After mastering the basics:
|
|
158
|
+
|
|
159
|
+
1. **Deep Algorithm Study**: Complete the full CS curriculum with `/learn`
|
|
160
|
+
2. **AI Model Experimentation**: Try different AI models for various tasks
|
|
161
|
+
3. **Performance Optimization**: Use benchmarking tools for your own code
|
|
162
|
+
4. **Community Engagement**: Share your learning journey
|
|
163
|
+
5. **Advanced Features**: Explore autonomous coding capabilities
|
|
164
|
+
|
|
165
|
+
## 🆘 Need Help?
|
|
166
|
+
|
|
167
|
+
- **Built-in Help**: `/help` command within MARIA
|
|
168
|
+
- **System Check**: `/status` for diagnostics
|
|
169
|
+
- **GitHub Issues**: [Report problems](https://github.com/bonginkan/maria/issues)
|
|
170
|
+
- **NPM Package**: [View documentation](https://www.npmjs.com/package/@bonginkan/maria)
|
|
171
|
+
|
|
172
|
+
## 🎉 Welcome to the Future
|
|
173
|
+
|
|
174
|
+
You're now part of the Algorithm Education Revolution! MARIA Platform combines:
|
|
175
|
+
|
|
176
|
+
- ✅ Interactive algorithm learning
|
|
177
|
+
- ✅ AI-powered development assistance
|
|
178
|
+
- ✅ 50 cognitive AI modes
|
|
179
|
+
- ✅ 36+ interactive commands
|
|
180
|
+
- ✅ Real-time performance analysis
|
|
181
|
+
- ✅ Complete CS curriculum
|
|
182
|
+
|
|
183
|
+
**Start exploring and happy learning! 🚀📚✨**
|
package/README.md
CHANGED
|
@@ -1,18 +1,34 @@
|
|
|
1
|
-
# MARIA Platform v1.
|
|
1
|
+
# 🤖 MARIA Platform v1.7.0 "Algorithm Education Revolution"
|
|
2
2
|
|
|
3
3
|
[](https://www.typescriptlang.org/)
|
|
4
|
-
[](https://www.npmjs.com/package/@bonginkan/maria)
|
|
5
4
|
[](https://nodejs.org/)
|
|
5
|
+
[](https://www.npmjs.com/package/@bonginkan/maria)
|
|
6
|
+
[](https://www.npmjs.com/package/@bonginkan/maria)
|
|
7
|
+
[](https://github.com/bonginkan/maria/blob/main/LICENSE)
|
|
6
8
|
[](https://github.com/bonginkan/maria)
|
|
7
9
|
[](https://github.com/bonginkan/maria)
|
|
8
10
|
|
|
9
|
-
**MARIA Platform v1.
|
|
11
|
+
> 🎉 **MARIA Platform v1.7.0 "Algorithm Education Revolution"** - Interactive AI Development CLI with Complete CS Curriculum, 36+ Slash Commands, 50 Cognitive AI Modes, and Educational Development Platform featuring the world's first **Internal Mode System**!
|
|
12
|
+
|
|
13
|
+
## 🌟 What's New in v1.7.0 "Algorithm Education Revolution"
|
|
10
14
|
|
|
11
|
-
|
|
15
|
+
### 🚀 Autonomous Coding Agent
|
|
12
16
|
|
|
13
|
-
|
|
17
|
+
- **World's First Fully Autonomous Professional Engineering AI**
|
|
18
|
+
- Complete software solutions from high-level requirements
|
|
19
|
+
- Visual progress tracking with real-time feedback
|
|
20
|
+
- Self-evolution learning engine
|
|
21
|
+
- 120+ professional engineering modes
|
|
14
22
|
|
|
15
|
-
###
|
|
23
|
+
### 📚 Algorithm Education Platform
|
|
24
|
+
|
|
25
|
+
- Interactive QuickSort implementation with visualization
|
|
26
|
+
- Performance analysis and benchmarking tools
|
|
27
|
+
- Memory profiling and optimization
|
|
28
|
+
- Computer science curriculum integration
|
|
29
|
+
- Educational sorting algorithms collection
|
|
30
|
+
|
|
31
|
+
### 🧠 Internal Mode System - Cognitive Adaptation Engine
|
|
16
32
|
|
|
17
33
|
- **50 Cognitive Modes**: Revolutionary thinking states across 9 categories (Reasoning, Creative, Analytical, etc.)
|
|
18
34
|
- **Real-time Recognition**: <200ms automatic mode switching based on context and intent
|
|
@@ -25,6 +41,14 @@
|
|
|
25
41
|
"Optimize this" → ✽ ⚡ Optimizing…
|
|
26
42
|
```
|
|
27
43
|
|
|
44
|
+
### 🎯 Key Features
|
|
45
|
+
|
|
46
|
+
- **Interactive Learning**: Hands-on algorithm education with visualization
|
|
47
|
+
- **Performance Analysis**: Real-time performance metrics and optimization
|
|
48
|
+
- **Professional Engineering**: Industry-standard development practices
|
|
49
|
+
- **Visual Progress**: Beautiful CLI interface with progress tracking
|
|
50
|
+
- **Autonomous Execution**: Complete task automation from requirements
|
|
51
|
+
|
|
28
52
|
### 🤖 Intelligent Router - Natural Language Command System
|
|
29
53
|
|
|
30
54
|
- **5-Language Support**: Native understanding in Japanese, English, Chinese, Korean, Vietnamese
|
|
@@ -104,10 +128,16 @@
|
|
|
104
128
|
|
|
105
129
|
## Quick Start
|
|
106
130
|
|
|
131
|
+
### Installation
|
|
132
|
+
|
|
107
133
|
```bash
|
|
108
|
-
# Install globally
|
|
134
|
+
# Install globally via npm
|
|
109
135
|
npm install -g @bonginkan/maria
|
|
110
136
|
|
|
137
|
+
# Verify installation
|
|
138
|
+
maria --version
|
|
139
|
+
# Output: MARIA Platform v1.6.4 "Algorithm Education Revolution"
|
|
140
|
+
|
|
111
141
|
# Setup local AI models (optional)
|
|
112
142
|
maria setup-ollama # Install and configure Ollama
|
|
113
143
|
maria setup-vllm # Install and configure vLLM
|
|
@@ -139,257 +169,186 @@ You: "研究論文を実装して" # → Triggers /paper for paper-to-code
|
|
|
139
169
|
/help # Full command reference
|
|
140
170
|
```
|
|
141
171
|
|
|
142
|
-
|
|
172
|
+
### Alternative Installation Methods
|
|
143
173
|
|
|
144
|
-
|
|
174
|
+
```bash
|
|
175
|
+
# Using yarn
|
|
176
|
+
yarn global add @bonginkan/maria
|
|
145
177
|
|
|
146
|
-
|
|
178
|
+
# Using pnpm
|
|
179
|
+
pnpm add -g @bonginkan/maria
|
|
180
|
+
```
|
|
147
181
|
|
|
148
|
-
|
|
182
|
+
## 🎯 Usage Examples
|
|
149
183
|
|
|
150
|
-
|
|
151
|
-
- **Responsive Range**: 80-200 character terminal support
|
|
152
|
-
- **Layout System**: 2-column layouts (80:36 ratio) with 4-character gaps
|
|
153
|
-
- **Perfect Centering**: All logos and content mathematically centered
|
|
184
|
+
### Basic Interactive Mode
|
|
154
185
|
|
|
155
|
-
|
|
186
|
+
```bash
|
|
187
|
+
# Start MARIA interactive CLI
|
|
188
|
+
maria
|
|
156
189
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
MUTED: chalk.gray, // Secondary text and borders
|
|
165
|
-
ACCENT: chalk.magenta, // Brand accents and highlights
|
|
166
|
-
};
|
|
190
|
+
# Available commands in interactive mode:
|
|
191
|
+
> /help # Show all commands
|
|
192
|
+
> /agent execute "create API" # Autonomous coding agent
|
|
193
|
+
> /agent demo # Demo autonomous capabilities
|
|
194
|
+
> /code "hello world function" # AI code generation
|
|
195
|
+
> /status # System status
|
|
196
|
+
> /exit # Exit
|
|
167
197
|
```
|
|
168
198
|
|
|
169
|
-
|
|
199
|
+
### Algorithm Education Commands
|
|
170
200
|
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
201
|
+
```bash
|
|
202
|
+
# Start MARIA and use algorithm education slash commands
|
|
203
|
+
maria
|
|
204
|
+
> /sort quicksort --visualize # Interactive sorting visualization
|
|
205
|
+
> /learn algorithms # Complete CS curriculum
|
|
206
|
+
> /benchmark sorting # Performance analysis
|
|
207
|
+
> /algorithm complexity # Big O notation tutorials
|
|
208
|
+
> /code "merge sort implementation" # AI-generated algorithms
|
|
209
|
+
```
|
|
174
210
|
|
|
175
|
-
|
|
211
|
+
### 36+ Interactive Slash Commands
|
|
176
212
|
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
213
|
+
```bash
|
|
214
|
+
# All commands are slash commands within interactive mode
|
|
215
|
+
maria
|
|
216
|
+
> /help # Show all 36+ commands
|
|
217
|
+
> /model # AI model selection
|
|
218
|
+
> /sort quicksort # Algorithm education
|
|
219
|
+
> /code "function" # AI code generation
|
|
220
|
+
> /bug analyze # Bug detection
|
|
221
|
+
> /lint check # Code quality
|
|
222
|
+
> /status # System status
|
|
223
|
+
> /mode internal # 50 cognitive AI modes
|
|
224
|
+
> /exit # Exit MARIA
|
|
186
225
|
```
|
|
187
226
|
|
|
188
|
-
|
|
227
|
+
## 🎨 Key Features
|
|
189
228
|
|
|
190
|
-
|
|
191
|
-
- **Internal Mode System**: 50 cognitive states (✽ Thinking…, ✽ Debugging…, ✽ Optimizing…)
|
|
192
|
-
- **Multi-Agent Orchestrator**: Coordinated specialized agents for complex tasks
|
|
193
|
-
- **DeepCode Integration**: Paper-to-code transformation with 8-agent architecture
|
|
194
|
-
- **CodeRAG System**: Semantic code search with graph-based dependency analysis
|
|
195
|
-
- **MCP Protocol**: Standardized tool-agent communication framework
|
|
196
|
-
- **124-Character UI Framework**: Responsive terminal design with unified color system
|
|
229
|
+
### 🤖 Autonomous Coding Agent
|
|
197
230
|
|
|
198
|
-
|
|
231
|
+
- **Complete SOW Generation**: Automatic Statement of Work creation
|
|
232
|
+
- **Visual Mode Display**: Real-time progress with beautiful UI
|
|
233
|
+
- **Active Reporting**: Progress tracking and status updates
|
|
234
|
+
- **Self-Evolution**: Learning engine that improves over time
|
|
235
|
+
- **120+ Engineering Modes**: Professional development patterns
|
|
199
236
|
|
|
200
|
-
|
|
201
|
-
- **Quality Analysis**: `/bug`, `/lint`, `/typecheck`, `/security-review` (enterprise-grade)
|
|
202
|
-
- **Interactive Session**: `src/services/interactive-session.ts` - 30+ commands with real-time interrupts
|
|
203
|
-
- **Google Workspace**: Direct integration for Docs, Slides, and Drive export
|
|
237
|
+
### 📊 Algorithm Education Platform
|
|
204
238
|
|
|
205
|
-
|
|
239
|
+
- **Interactive QuickSort**: Step-by-step algorithm visualization
|
|
240
|
+
- **Performance Benchmarking**: Compare algorithm efficiency
|
|
241
|
+
- **Memory Profiling**: Analyze memory usage patterns
|
|
242
|
+
- **Educational Tools**: Computer science curriculum support
|
|
243
|
+
- **Sorting Algorithms**: Complete collection with analysis
|
|
206
244
|
|
|
207
|
-
|
|
208
|
-
- **Context Preservation**: Deep semantic compression with knowledge graph construction
|
|
209
|
-
- **Predictive Analytics**: ML-powered intent prediction and workflow optimization
|
|
210
|
-
- **Real-time Processing**: <200ms response with interrupt handling and streaming
|
|
245
|
+
### 🔧 Development Tools
|
|
211
246
|
|
|
212
|
-
|
|
247
|
+
- **AI Code Generation**: Multi-language code creation
|
|
248
|
+
- **Intelligent Assistance**: Context-aware development help
|
|
249
|
+
- **Project Analysis**: Codebase understanding and insights
|
|
250
|
+
- **Quality Assurance**: Automated testing and validation
|
|
251
|
+
- **Version Control**: Git integration and workflow support
|
|
213
252
|
|
|
214
|
-
|
|
215
|
-
- **Multi-AI Integration**: 22+ models (OpenAI, Anthropic, Google, xAI, Groq, LM Studio, Ollama, vLLM)
|
|
216
|
-
- **Local AI Support**: Native integration with LM Studio, Ollama, and vLLM for private deployments
|
|
217
|
-
- **Enterprise Standards**: OWASP compliance, security vulnerability assessment
|
|
218
|
-
- **Natural Language Processing**: Intent recognition with 95%+ accuracy across 5 languages
|
|
253
|
+
## 🌍 Supported Platforms
|
|
219
254
|
|
|
220
|
-
|
|
255
|
+
- **Node.js**: 18.0.0 - 22.x
|
|
256
|
+
- **Operating Systems**: macOS, Linux, Windows
|
|
257
|
+
- **Terminals**: All major terminal applications
|
|
258
|
+
- **Shells**: bash, zsh, fish, PowerShell
|
|
221
259
|
|
|
222
|
-
|
|
260
|
+
## 📚 Documentation
|
|
223
261
|
|
|
224
|
-
|
|
225
|
-
# Development workflow
|
|
226
|
-
pnpm build # Build CLI using tsup
|
|
227
|
-
pnpm dev # Watch mode development
|
|
228
|
-
pnpm clean # Remove dist/ directory
|
|
229
|
-
|
|
230
|
-
# Quality assurance (ZERO errors/warnings policy)
|
|
231
|
-
pnpm lint --max-warnings 0 # ESLint with zero warnings enforced
|
|
232
|
-
pnpm type-check # TypeScript type checking
|
|
233
|
-
pnpm test # Run test suite
|
|
234
|
-
pnpm test:coverage # Tests with coverage
|
|
235
|
-
|
|
236
|
-
# Local testing
|
|
237
|
-
npm link # Global CLI installation
|
|
238
|
-
maria --version # Test CLI functionality
|
|
239
|
-
maria # Interactive mode
|
|
240
|
-
```
|
|
262
|
+
### Command Reference
|
|
241
263
|
|
|
242
|
-
|
|
264
|
+
- **Interactive Mode**: `maria` (starts directly)
|
|
265
|
+
- **All Commands**: `/help` within interactive mode
|
|
266
|
+
- **Algorithm Education**: `/sort`, `/learn`, `/algorithm` commands
|
|
267
|
+
- **AI Development**: `/code`, `/bug`, `/lint`, `/model` commands
|
|
268
|
+
- **System Status**: `/status` command
|
|
243
269
|
|
|
244
|
-
|
|
245
|
-
# AI Provider APIs
|
|
246
|
-
OPENAI_API_KEY=sk-...
|
|
247
|
-
ANTHROPIC_API_KEY=sk-ant-...
|
|
248
|
-
GOOGLE_AI_API_KEY=AIza...
|
|
249
|
-
GROQ_API_KEY=gsk_...
|
|
250
|
-
|
|
251
|
-
# Local Models (integrated support)
|
|
252
|
-
LMSTUDIO_API_URL=http://localhost:1234
|
|
253
|
-
OLLAMA_API_URL=http://localhost:11434
|
|
254
|
-
VLLM_API_URL=http://localhost:8000
|
|
255
|
-
```
|
|
270
|
+
### Examples and Tutorials
|
|
256
271
|
|
|
257
|
-
|
|
272
|
+
- **Getting Started**: Run `maria` and type `/help`
|
|
273
|
+
- **Algorithm Learning**: Use `/sort quicksort --visualize` for interactive tutorials
|
|
274
|
+
- **Development Workflow**: AI-assisted coding with `/code` commands
|
|
275
|
+
- **Performance Analysis**: Built-in benchmarking with `/benchmark` commands
|
|
258
276
|
|
|
259
|
-
|
|
277
|
+
## 🔧 Configuration
|
|
278
|
+
MARIA works out of the box with no configuration required. For advanced features:
|
|
260
279
|
|
|
261
280
|
```bash
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
**Zero-Error Policy**:
|
|
281
|
+
# Start interactive mode (default)
|
|
282
|
+
maria
|
|
266
283
|
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
- TypeScript errors: 0 (blocking)
|
|
270
|
-
- Failed tests: 0 (blocking)
|
|
271
|
-
- Build failures: 0 (blocking)
|
|
284
|
+
# Check system status
|
|
285
|
+
> /status
|
|
272
286
|
|
|
273
|
-
|
|
287
|
+
# Configure AI providers
|
|
288
|
+
> /model # Select from 22+ AI models (GPT, Claude, Gemini, Local LLMs)
|
|
274
289
|
|
|
290
|
+
# Algorithm education
|
|
291
|
+
> /sort quicksort --visualize # Interactive learning
|
|
275
292
|
```
|
|
276
|
-
src/
|
|
277
|
-
├── cli.ts # Main CLI entry point
|
|
278
|
-
├── commands/ # Individual CLI commands
|
|
279
|
-
├── services/
|
|
280
|
-
│ ├── interactive-session.ts # Interactive mode handler
|
|
281
|
-
│ ├── intelligent-router/ # Natural language processing
|
|
282
|
-
│ ├── adaptive-learning-engine.ts
|
|
283
|
-
│ ├── enhanced-context-preservation.ts
|
|
284
|
-
│ ├── automated-code-quality.ts
|
|
285
|
-
│ └── ...
|
|
286
|
-
├── providers/ # AI model integrations
|
|
287
|
-
├── components/ # React components for UI
|
|
288
|
-
└── types/ # TypeScript definitions
|
|
289
|
-
|
|
290
|
-
dist/ # Compiled output
|
|
291
|
-
bin/maria # Executable CLI
|
|
292
|
-
maria-oss/ # OSS distribution package
|
|
293
|
-
```
|
|
294
|
-
|
|
295
|
-
## Contributing
|
|
296
293
|
|
|
297
|
-
|
|
294
|
+
## 🤝 Contributing
|
|
298
295
|
|
|
299
|
-
|
|
300
|
-
2. Register in CLI setup
|
|
301
|
-
3. Add slash command handler in `interactive-session.ts`
|
|
302
|
-
4. Update help text and documentation
|
|
303
|
-
5. Ensure zero-error policy compliance
|
|
296
|
+
We welcome contributions to MARIA! Please check our [contribution guidelines](https://github.com/bonginkan/maria/blob/main/CONTRIBUTING.md).
|
|
304
297
|
|
|
305
|
-
###
|
|
298
|
+
### Development Setup
|
|
306
299
|
|
|
307
300
|
```bash
|
|
308
|
-
#
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
# Verify core functionality
|
|
312
|
-
maria --version # Should show current version
|
|
313
|
-
maria status # System health check
|
|
314
|
-
maria # Interactive mode
|
|
315
|
-
|
|
316
|
-
# Test commands in interactive mode
|
|
317
|
-
/help # All 30+ commands
|
|
318
|
-
/model # AI model selection
|
|
319
|
-
/code "hello world function" # Code generation
|
|
320
|
-
/exit # Clean session termination
|
|
321
|
-
```
|
|
322
|
-
|
|
323
|
-
## 📦 Distribution & Licensing
|
|
324
|
-
|
|
325
|
-
### Distribution Channels
|
|
301
|
+
# Clone the repository
|
|
302
|
+
git clone https://github.com/bonginkan/maria.git
|
|
303
|
+
cd maria
|
|
326
304
|
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
- **NPM Package**: `@bonginkan/maria` (v1.1.0+, compiled distribution)
|
|
305
|
+
# Install dependencies
|
|
306
|
+
npm install
|
|
330
307
|
|
|
331
|
-
|
|
308
|
+
# Build the project
|
|
309
|
+
npm run build
|
|
332
310
|
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
- **Individual Developers**: Free for personal projects, learning, and non-commercial use
|
|
338
|
-
- **Open Source Projects**: Free for open-source software development
|
|
339
|
-
- **Students & Academics**: Free for educational and research purposes
|
|
340
|
-
- **Startups**: Free for companies under 10 employees or $1M ARR
|
|
341
|
-
|
|
342
|
-
#### 🏢 Enterprise License (Paid)
|
|
343
|
-
|
|
344
|
-
- **Commercial Organizations**: Required for companies over 10 employees or $1M ARR
|
|
345
|
-
- **Enterprise Features**: Advanced security, compliance, priority support
|
|
346
|
-
- **Custom Integrations**: Tailored implementations and dedicated support
|
|
347
|
-
- **SLA Guarantees**: 99.9% uptime, <24hr response times
|
|
348
|
-
|
|
349
|
-
### 🔒 Source Code Protection
|
|
350
|
-
|
|
351
|
-
- **Compiled Distribution Only**: Source code (`src/`) is not distributed publicly
|
|
352
|
-
- **NPM Package**: Contains only compiled JavaScript binaries and type definitions
|
|
353
|
-
- **Intellectual Property**: Core algorithms and AI systems remain proprietary
|
|
354
|
-
- **Security**: Closed-source model ensures enterprise-grade security and compliance
|
|
311
|
+
# Run locally
|
|
312
|
+
./bin/maria
|
|
313
|
+
```
|
|
355
314
|
|
|
356
|
-
|
|
315
|
+
## 📄 License
|
|
357
316
|
|
|
358
|
-
-
|
|
359
|
-
- **Custom Deployments**: Custom implementations for large organizations
|
|
360
|
-
- **Training & Certification**: Professional development programs
|
|
361
|
-
- **24/7 Support**: Dedicated enterprise support channels
|
|
317
|
+
MIT License - see [LICENSE](https://github.com/bonginkan/maria/blob/main/LICENSE) for details.
|
|
362
318
|
|
|
363
|
-
|
|
319
|
+
## 🔗 Links
|
|
364
320
|
|
|
365
|
-
|
|
321
|
+
- **NPM Package**: [npmjs.com/package/@bonginkan/maria](https://www.npmjs.com/package/@bonginkan/maria)
|
|
322
|
+
- **GitHub Repository**: [github.com/bonginkan/maria](https://github.com/bonginkan/maria)
|
|
323
|
+
- **Documentation**: Available via `maria --help`
|
|
324
|
+
- **Support**: [GitHub Issues](https://github.com/bonginkan/maria/issues)
|
|
366
325
|
|
|
367
|
-
|
|
326
|
+
## 🎯 What Makes MARIA Special
|
|
368
327
|
|
|
369
|
-
|
|
370
|
-
- **[👨💻 Developer Guide](./DEVELOPER_GUIDE_v1.1.0.md)** - Comprehensive development guide with API reference, customization, and enterprise deployment
|
|
371
|
-
- **[👤 User Manual](./USER_MANUAL_v1.1.0.md)** - Complete user guide with step-by-step tutorials and best practices
|
|
372
|
-
- **[📖 Claude AI Instructions](./CLAUDE.md)** - Complete platform overview and development guidelines for AI assistance
|
|
328
|
+
### Revolutionary AI Development
|
|
373
329
|
|
|
374
|
-
|
|
330
|
+
- **First Autonomous AI**: Complete software development from requirements
|
|
331
|
+
- **Visual Progress**: Beautiful CLI with real-time feedback
|
|
332
|
+
- **Educational Focus**: Algorithm learning with interactive visualization
|
|
333
|
+
- **Professional Quality**: Industry-standard engineering practices
|
|
375
334
|
|
|
376
|
-
|
|
377
|
-
- **Installation**: [User Manual - Installation Guide](./USER_MANUAL_v1.1.0.md#installation-guide)
|
|
378
|
-
- **Code Quality Analysis**: [Technical Specification - Code Quality Platform](./SPEC_SHEET_v1.1.0.md#code-quality-analysis-infrastructure)
|
|
379
|
-
- **API Development**: [Developer Guide - API Reference](./DEVELOPER_GUIDE_v1.1.0.md#api-reference)
|
|
380
|
-
- **Enterprise Deployment**: [Developer Guide - Enterprise Deployment](./DEVELOPER_GUIDE_v1.1.0.md#enterprise-deployment)
|
|
381
|
-
- **Troubleshooting**: [User Manual - Troubleshooting](./USER_MANUAL_v1.1.0.md#troubleshooting)
|
|
335
|
+
### Cutting-Edge Technology
|
|
382
336
|
|
|
383
|
-
|
|
337
|
+
- **Advanced AI Integration**: Multiple AI model support
|
|
338
|
+
- **Intelligent Automation**: Self-learning and adaptation
|
|
339
|
+
- **Modern CLI Experience**: Beautiful, responsive interface
|
|
340
|
+
- **Cross-Platform**: Works everywhere Node.js runs
|
|
384
341
|
|
|
385
|
-
|
|
342
|
+
### Perfect for:
|
|
386
343
|
|
|
387
|
-
- **
|
|
388
|
-
- **
|
|
389
|
-
- **
|
|
390
|
-
|
|
391
|
-
Future versions (v1.1.1, v1.2.0, etc.) will maintain separate versioned documentation alongside existing files for complete historical reference and seamless upgrade paths.
|
|
344
|
+
- **Students**: Learn algorithms with interactive visualization
|
|
345
|
+
- **Developers**: Accelerate development with AI assistance
|
|
346
|
+
- **Teams**: Collaborative development with autonomous agents
|
|
347
|
+
- **Educators**: Teach computer science with hands-on tools
|
|
392
348
|
|
|
393
349
|
---
|
|
394
350
|
|
|
395
|
-
**
|
|
351
|
+
**Experience the Algorithm Education Revolution with MARIA Platform v1.6.4**
|
|
352
|
+
|
|
353
|
+
🚀 Start your journey: `npm install -g @bonginkan/maria && maria`
|
|
354
|
+
>>>>>>> release/v1.6.0
|
package/SETUP.md
ADDED
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
# 🚀 MARIA Platform Setup Guide
|
|
2
|
+
|
|
3
|
+
Complete setup instructions for MARIA Platform v1.6.4 "Algorithm Education Revolution"
|
|
4
|
+
|
|
5
|
+
## 📋 System Requirements
|
|
6
|
+
|
|
7
|
+
### Minimum Requirements
|
|
8
|
+
- **Node.js**: 18.0.0 or higher (up to 22.x)
|
|
9
|
+
- **npm**: 8.0.0 or higher
|
|
10
|
+
- **Operating System**: macOS, Linux, Windows
|
|
11
|
+
- **Terminal**: Any modern terminal application
|
|
12
|
+
- **Memory**: 512MB available RAM
|
|
13
|
+
- **Storage**: 100MB disk space
|
|
14
|
+
|
|
15
|
+
### Recommended Setup
|
|
16
|
+
- **Node.js**: 20.x LTS
|
|
17
|
+
- **Terminal**: iTerm2 (macOS), Windows Terminal, or VS Code integrated terminal
|
|
18
|
+
- **Shell**: bash, zsh, fish, or PowerShell
|
|
19
|
+
- **Memory**: 1GB+ available RAM for optimal performance
|
|
20
|
+
|
|
21
|
+
## 🛠️ Installation Methods
|
|
22
|
+
|
|
23
|
+
### Method 1: NPM Global Installation (Recommended)
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
# Install globally via npm
|
|
27
|
+
npm install -g @bonginkan/maria
|
|
28
|
+
|
|
29
|
+
# Verify installation
|
|
30
|
+
maria --version
|
|
31
|
+
# Expected output: MARIA Platform v1.6.4 "Algorithm Education Revolution"
|
|
32
|
+
|
|
33
|
+
# Test interactive mode
|
|
34
|
+
maria
|
|
35
|
+
# Should start interactive CLI with welcome message
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Method 2: Alternative Package Managers
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
# Using Yarn
|
|
42
|
+
yarn global add @bonginkan/maria
|
|
43
|
+
|
|
44
|
+
# Using pnpm
|
|
45
|
+
pnpm add -g @bonginkan/maria
|
|
46
|
+
|
|
47
|
+
# Using npx (temporary usage)
|
|
48
|
+
npx @bonginkan/maria
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Method 3: Local Project Installation
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
# Install in project
|
|
55
|
+
npm install @bonginkan/maria
|
|
56
|
+
|
|
57
|
+
# Run locally
|
|
58
|
+
npx maria
|
|
59
|
+
|
|
60
|
+
# Or add to package.json scripts
|
|
61
|
+
{
|
|
62
|
+
"scripts": {
|
|
63
|
+
"ai": "maria"
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## ⚡ Quick Start Guide
|
|
69
|
+
|
|
70
|
+
### 1. First Launch
|
|
71
|
+
```bash
|
|
72
|
+
# Start MARIA interactive mode
|
|
73
|
+
maria
|
|
74
|
+
|
|
75
|
+
# You should see:
|
|
76
|
+
# 🤖 MARIA Platform v1.6.4 "Algorithm Education Revolution"
|
|
77
|
+
# Interactive AI Development CLI with Complete CS Curriculum
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### 2. Basic Commands
|
|
81
|
+
```bash
|
|
82
|
+
# Within interactive mode, try these commands:
|
|
83
|
+
> /help # Show all 36+ commands
|
|
84
|
+
> /status # Check system status
|
|
85
|
+
> /model # Configure AI providers
|
|
86
|
+
> /sort quicksort --visualize # Try algorithm education
|
|
87
|
+
> /code "hello world function" # AI code generation
|
|
88
|
+
> /exit # Exit MARIA
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### 3. Algorithm Education
|
|
92
|
+
```bash
|
|
93
|
+
# Start learning algorithms
|
|
94
|
+
> /sort quicksort # Interactive quicksort tutorial
|
|
95
|
+
> /learn algorithms # Complete CS curriculum
|
|
96
|
+
> /benchmark sorting # Performance analysis
|
|
97
|
+
> /algorithm complexity # Big O notation guide
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## 🔧 Configuration
|
|
101
|
+
|
|
102
|
+
### AI Model Setup (Optional)
|
|
103
|
+
|
|
104
|
+
MARIA works out of the box with default models, but you can configure additional AI providers:
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
# Start MARIA and configure models
|
|
108
|
+
maria
|
|
109
|
+
> /model
|
|
110
|
+
|
|
111
|
+
# Available options:
|
|
112
|
+
# - OpenAI GPT models (API key required)
|
|
113
|
+
# - Anthropic Claude (API key required)
|
|
114
|
+
# - Google Gemini (API key required)
|
|
115
|
+
# - Local LLMs (LM Studio, Ollama)
|
|
116
|
+
# - Groq models (API key required)
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Environment Variables (Optional)
|
|
120
|
+
|
|
121
|
+
Create a `.env` file in your project or set system environment variables:
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
# AI Provider API Keys (optional)
|
|
125
|
+
OPENAI_API_KEY=sk-your-key-here
|
|
126
|
+
ANTHROPIC_API_KEY=sk-ant-your-key-here
|
|
127
|
+
GOOGLE_AI_API_KEY=your-google-key-here
|
|
128
|
+
GROQ_API_KEY=gsk-your-groq-key-here
|
|
129
|
+
|
|
130
|
+
# Local AI Models (optional)
|
|
131
|
+
LMSTUDIO_API_URL=http://localhost:1234
|
|
132
|
+
OLLAMA_API_URL=http://localhost:11434
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## 🎓 Learning Path
|
|
136
|
+
|
|
137
|
+
### For Students & Beginners
|
|
138
|
+
1. Start with basic installation: `npm install -g @bonginkan/maria`
|
|
139
|
+
2. Launch interactive mode: `maria`
|
|
140
|
+
3. Try algorithm education: `/sort quicksort --visualize`
|
|
141
|
+
4. Explore help system: `/help`
|
|
142
|
+
5. Learn coding basics: `/code "simple function"`
|
|
143
|
+
|
|
144
|
+
### For Developers
|
|
145
|
+
1. Install MARIA: `npm install -g @bonginkan/maria`
|
|
146
|
+
2. Configure preferred AI model: `/model`
|
|
147
|
+
3. Try development commands: `/code`, `/bug`, `/lint`
|
|
148
|
+
4. Explore advanced features: `/status`, `/mode internal`
|
|
149
|
+
5. Integrate with workflow: Use MARIA for coding assistance
|
|
150
|
+
|
|
151
|
+
### For Educators
|
|
152
|
+
1. Install for classroom use: `npm install -g @bonginkan/maria`
|
|
153
|
+
2. Explore algorithm curriculum: `/learn algorithms`
|
|
154
|
+
3. Use visualization tools: `/sort --visualize`
|
|
155
|
+
4. Create lesson plans with `/help` command reference
|
|
156
|
+
5. Demonstrate CS concepts with interactive examples
|
|
157
|
+
|
|
158
|
+
## 🐛 Troubleshooting
|
|
159
|
+
|
|
160
|
+
### Common Issues
|
|
161
|
+
|
|
162
|
+
#### Permission Errors
|
|
163
|
+
```bash
|
|
164
|
+
# If you get permission errors on macOS/Linux:
|
|
165
|
+
sudo npm install -g @bonginkan/maria
|
|
166
|
+
|
|
167
|
+
# Or use npm prefix:
|
|
168
|
+
npm config set prefix ~/.npm-global
|
|
169
|
+
export PATH=~/.npm-global/bin:$PATH
|
|
170
|
+
npm install -g @bonginkan/maria
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
#### Node.js Version Issues
|
|
174
|
+
```bash
|
|
175
|
+
# Check Node.js version
|
|
176
|
+
node --version
|
|
177
|
+
|
|
178
|
+
# If version is too old, update Node.js:
|
|
179
|
+
# Visit https://nodejs.org/ for latest LTS version
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
#### Command Not Found
|
|
183
|
+
```bash
|
|
184
|
+
# Check if MARIA is in PATH
|
|
185
|
+
which maria
|
|
186
|
+
|
|
187
|
+
# If not found, try:
|
|
188
|
+
npm list -g @bonginkan/maria
|
|
189
|
+
|
|
190
|
+
# Reinstall if necessary:
|
|
191
|
+
npm uninstall -g @bonginkan/maria
|
|
192
|
+
npm install -g @bonginkan/maria
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
#### Interactive Mode Issues
|
|
196
|
+
```bash
|
|
197
|
+
# If interactive mode doesn't start:
|
|
198
|
+
maria --help
|
|
199
|
+
|
|
200
|
+
# Check for terminal compatibility:
|
|
201
|
+
echo $TERM
|
|
202
|
+
|
|
203
|
+
# Try different terminal or shell
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
### Getting Help
|
|
207
|
+
|
|
208
|
+
1. **Built-in Help**: Use `/help` within MARIA
|
|
209
|
+
2. **Version Check**: Run `maria --version`
|
|
210
|
+
3. **System Status**: Use `/status` command
|
|
211
|
+
4. **GitHub Issues**: [Report issues](https://github.com/bonginkan/maria/issues)
|
|
212
|
+
5. **NPM Package**: [View on npmjs.com](https://www.npmjs.com/package/@bonginkan/maria)
|
|
213
|
+
|
|
214
|
+
## 📚 Next Steps
|
|
215
|
+
|
|
216
|
+
After successful setup:
|
|
217
|
+
|
|
218
|
+
1. **Explore Commands**: Try all 36+ slash commands with `/help`
|
|
219
|
+
2. **Algorithm Learning**: Deep dive into CS curriculum with `/learn`
|
|
220
|
+
3. **AI Development**: Use AI assistance for coding projects
|
|
221
|
+
4. **Performance Analysis**: Benchmark algorithms with built-in tools
|
|
222
|
+
5. **Advanced Features**: Explore 50 cognitive AI modes with `/mode internal`
|
|
223
|
+
|
|
224
|
+
## 🌟 Pro Tips
|
|
225
|
+
|
|
226
|
+
- **Quick Access**: Create shell alias: `alias ai="maria"`
|
|
227
|
+
- **Project Integration**: Add MARIA to project's package.json
|
|
228
|
+
- **Learning Schedule**: Dedicate 15 minutes daily to algorithm education
|
|
229
|
+
- **Experiment**: Try different AI models to find your preference
|
|
230
|
+
- **Share**: Introduce MARIA to your team for collaborative development
|
|
231
|
+
|
|
232
|
+
---
|
|
233
|
+
|
|
234
|
+
**Welcome to the Algorithm Education Revolution! 🎓✨**
|
|
235
|
+
|
|
236
|
+
Start your journey: `maria` and type `/help` to explore all possibilities.
|
package/bin/maria
CHANGED
|
@@ -13,24 +13,25 @@ const fs = require('fs');
|
|
|
13
13
|
// Get the script directory and project root
|
|
14
14
|
const binDir = __dirname;
|
|
15
15
|
const projectRoot = path.dirname(binDir);
|
|
16
|
+
const mariaFile = path.join(projectRoot, 'dist', 'bin', 'maria.js');
|
|
16
17
|
const cliFile = path.join(projectRoot, 'dist', 'cli.js');
|
|
17
18
|
|
|
18
19
|
// Check if running with arguments or in interactive mode
|
|
19
20
|
const hasArgs = process.argv.length > 2;
|
|
20
21
|
|
|
21
|
-
// Check if CLI file exists
|
|
22
|
-
if (!fs.existsSync(cliFile)) {
|
|
23
|
-
console.error('❌ CLI file not found:', cliFile);
|
|
24
|
-
console.error('💡 Please run: pnpm build');
|
|
25
|
-
process.exit(1);
|
|
26
|
-
}
|
|
27
|
-
|
|
28
22
|
if (hasArgs) {
|
|
29
23
|
// If arguments provided, use the built CLI for commands
|
|
30
|
-
console.log('🚀 MARIA
|
|
24
|
+
console.log('🚀 MARIA CODE CLI - Command Mode');
|
|
25
|
+
|
|
26
|
+
// Check if built maria file exists
|
|
27
|
+
if (!fs.existsSync(mariaFile)) {
|
|
28
|
+
console.error('❌ Built file not found:', mariaFile);
|
|
29
|
+
console.error('💡 Please run: pnpm build');
|
|
30
|
+
process.exit(1);
|
|
31
|
+
}
|
|
31
32
|
|
|
32
|
-
// Launch the
|
|
33
|
-
const child = spawn('node', ['--no-deprecation',
|
|
33
|
+
// Launch the maria entry point with version check
|
|
34
|
+
const child = spawn('node', ['--no-deprecation', mariaFile, ...process.argv.slice(2)], {
|
|
34
35
|
stdio: 'inherit',
|
|
35
36
|
cwd: process.cwd(),
|
|
36
37
|
env: { ...process.env, NODE_NO_WARNINGS: '1' }
|
|
@@ -46,10 +47,17 @@ if (hasArgs) {
|
|
|
46
47
|
});
|
|
47
48
|
|
|
48
49
|
} else {
|
|
49
|
-
// If no arguments, launch
|
|
50
|
+
// If no arguments, launch interactive mode directly
|
|
51
|
+
|
|
52
|
+
// Check if maria.js file exists
|
|
53
|
+
if (!fs.existsSync(mariaFile)) {
|
|
54
|
+
console.error('❌ Built file not found:', mariaFile);
|
|
55
|
+
console.error('💡 Please run: pnpm build');
|
|
56
|
+
process.exit(1);
|
|
57
|
+
}
|
|
50
58
|
|
|
51
|
-
// Launch the
|
|
52
|
-
const child = spawn('node', ['--no-deprecation',
|
|
59
|
+
// Launch the maria entry point directly for interactive mode
|
|
60
|
+
const child = spawn('node', ['--no-deprecation', mariaFile], {
|
|
53
61
|
stdio: 'inherit',
|
|
54
62
|
cwd: process.cwd(),
|
|
55
63
|
env: { ...process.env, NODE_NO_WARNINGS: '1' }
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bonginkan/maria",
|
|
3
|
-
"version": "1.
|
|
4
|
-
"description": "MARIA Platform v1.
|
|
3
|
+
"version": "1.7.0",
|
|
4
|
+
"description": "MARIA Platform v1.7.0 \"Algorithm Education Revolution\" - Revolutionary AI Development Platform with 120+ Professional Engineering Modes, Algorithm Education Platform, Real-time Visual Progress, Complete Software Development Lifecycle, and Interactive CS Curriculum",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ai",
|
|
7
7
|
"cli",
|
|
@@ -69,6 +69,9 @@
|
|
|
69
69
|
"dist",
|
|
70
70
|
"bin",
|
|
71
71
|
"README.md",
|
|
72
|
+
"SETUP.md",
|
|
73
|
+
"GETTING_STARTED.md",
|
|
74
|
+
"COMMANDS.md",
|
|
72
75
|
"LICENSE"
|
|
73
76
|
],
|
|
74
77
|
"type": "commonjs",
|
|
@@ -93,14 +96,57 @@
|
|
|
93
96
|
"release:beta": "pnpm publish --tag beta"
|
|
94
97
|
},
|
|
95
98
|
"dependencies": {
|
|
99
|
+
"@anthropic-ai/sdk": "^0.20.0",
|
|
100
|
+
"@google/generative-ai": "^0.1.0",
|
|
101
|
+
"@langchain/core": "^0.1.0",
|
|
102
|
+
"@sindresorhus/slugify": "^2.2.1",
|
|
96
103
|
"chalk": "^5.3.0",
|
|
97
|
-
"
|
|
104
|
+
"cli-progress": "^3.12.0",
|
|
105
|
+
"commander": "^12.0.0",
|
|
106
|
+
"console-table-printer": "^2.14.6",
|
|
107
|
+
"dotenv": "^16.4.1",
|
|
108
|
+
"figlet": "^1.7.0",
|
|
109
|
+
"fs-extra": "^11.2.0",
|
|
110
|
+
"gpt-3-encoder": "^1.1.4",
|
|
111
|
+
"groq-sdk": "^0.3.0",
|
|
112
|
+
"ink": "^4.4.1",
|
|
113
|
+
"ink-select-input": "^5.0.0",
|
|
114
|
+
"ink-spinner": "^4.0.3",
|
|
115
|
+
"ink-text-input": "^5.0.1",
|
|
116
|
+
"inquirer": "^12.0.0",
|
|
117
|
+
"jsonwebtoken": "^9.0.2",
|
|
118
|
+
"node-fetch": "^3.3.2",
|
|
119
|
+
"openai": "^4.28.0",
|
|
120
|
+
"ora": "^8.0.1",
|
|
121
|
+
"p-limit": "^5.0.0",
|
|
122
|
+
"prompts": "^2.4.2",
|
|
123
|
+
"react": "^18.2.0",
|
|
124
|
+
"strip-ansi": "^7.1.0",
|
|
125
|
+
"uuid": "^9.0.1",
|
|
126
|
+
"winston": "^3.11.0",
|
|
127
|
+
"ws": "^8.16.0",
|
|
128
|
+
"zod": "^3.22.4"
|
|
98
129
|
},
|
|
99
130
|
"devDependencies": {
|
|
131
|
+
"@types/cli-progress": "^3.11.5",
|
|
132
|
+
"@types/figlet": "^1.5.8",
|
|
133
|
+
"@types/fs-extra": "^11.0.4",
|
|
134
|
+
"@types/inquirer": "^9.0.7",
|
|
135
|
+
"@types/jsonwebtoken": "^9.0.5",
|
|
100
136
|
"@types/node": "^20.11.0",
|
|
101
|
-
"
|
|
137
|
+
"@types/react": "^18.2.48",
|
|
138
|
+
"@types/uuid": "^9.0.8",
|
|
139
|
+
"@types/ws": "^8.5.10",
|
|
140
|
+
"@typescript-eslint/eslint-plugin": "^6.19.0",
|
|
141
|
+
"@typescript-eslint/parser": "^6.19.0",
|
|
142
|
+
"@vitest/coverage-v8": "^1.2.0",
|
|
143
|
+
"eslint": "^8.56.0",
|
|
144
|
+
"eslint-config-prettier": "^9.1.0",
|
|
145
|
+
"eslint-plugin-prettier": "^5.1.3",
|
|
146
|
+
"prettier": "^3.2.4",
|
|
102
147
|
"tsup": "^8.0.1",
|
|
103
|
-
"typescript": "^5.3.3"
|
|
148
|
+
"typescript": "^5.3.3",
|
|
149
|
+
"vitest": "^1.2.0"
|
|
104
150
|
},
|
|
105
151
|
"publishConfig": {
|
|
106
152
|
"access": "public",
|