1- # Yoda - Personal Assistant CLI
1+ # Yoda - Personal Assistant CLI
22
33[ ![ Go Version] ( https://img.shields.io/badge/Go-1.24+-blue.svg )] ( https://golang.org )
44[ ![ License] ( https://img.shields.io/badge/License-MIT-green.svg )] ( LICENSE )
55
66Yoda is a modern, extensible command-line personal assistant built in Go. It features a plugin-based architecture, local AI integration via Ollama, and a focus on privacy and performance.
77
8- ## Features
8+ ## 1. Features
99
1010- ** Fast Performance** : Built in Go for speed and efficiency
1111- ** Plugin Architecture** : Extensible with custom plugins
@@ -14,11 +14,11 @@ Yoda is a modern, extensible command-line personal assistant built in Go. It fea
1414- ** Configuration Management** : Flexible YAML-based configuration
1515- ** Cross-Platform** : Works on Linux, macOS, and Windows
1616
17- ## Quick Start
17+ ## 2. Quick Start
1818
19- ### Installation
19+ ### 2.1. Installation
2020
21- #### Option 1: Build from Source
21+ #### 2.1.1. Option 1: Build from Source
2222
2323``` bash
2424# Clone the repository
@@ -31,11 +31,11 @@ make build
3131make install
3232```
3333
34- #### Option 2: Download Pre-built Binary
34+ #### 2.1.2. Option 2: Download Pre-built Binary
3535
3636Download the latest release for your platform from the [ releases page] ( https://github.com/94solutions/yoda/releases ) .
3737
38- ### Initial Setup
38+ ### 2.2. Initial Setup
3939
4040Initialize Yoda configuration:
4141
@@ -45,7 +45,7 @@ yoda init
4545
4646This creates the configuration directory at ` ~/.yoda/ ` and sets up the default configuration.
4747
48- ### Basic Usage
48+ ### 2.3. Basic Usage
4949
5050``` bash
5151# Show help
@@ -64,11 +64,11 @@ yoda config get global.ai.model
6464yoda config set global.ai.model " llama3.1"
6565```
6666
67- ## Configuration
67+ ## 3. Configuration
6868
6969Yoda uses a YAML configuration file located at ` ~/.yoda/config.yaml ` . The configuration includes:
7070
71- ### AI Settings
71+ ### 3.1. AI Settings
7272``` yaml
7373global :
7474 ai :
@@ -78,7 +78,7 @@ global:
7878 base_url : " http://localhost:11434"
7979` ` `
8080
81- ### Plugin Settings
81+ ### 3.2. Plugin Settings
8282` ` ` yaml
8383global :
8484 plugins :
@@ -88,39 +88,39 @@ global:
8888 disabled_plugins : []
8989` ` `
9090
91- ### Security Settings
91+ ### 3.3. Security Settings
9292` ` ` yaml
9393global :
9494 security :
9595 plugin_sandboxing : true
9696 api_rate_limiting : true
9797` ` `
9898
99- ## Plugin Management
99+ ## 4. Plugin Management
100100
101- ### Built-in Commands
101+ ### 4.1. Built-in Commands
102102
103103- ` yoda plugin list` - List all available plugins
104104- ` yoda plugin enable <name>` - Enable a plugin
105105- ` yoda plugin disable <name>` - Disable a plugin
106106- ` yoda plugin refresh` - Refresh plugin registry
107107
108- # ## Plugin Development
108+ # ## 4.2. Plugin Development
109109
110110Yoda supports an extensible plugin system. Plugins can be :
111111
1121121. **Built-in plugins** - Core functionality (config, plugin management)
1131132. **External plugins** - Custom functionality (coming soon)
1141143. **AI-generated plugins** - Generated by the AI backend (planned)
115115
116- # # Development
116+ # # 5. Development
117117
118- # ## Prerequisites
118+ # ## 5.1. Prerequisites
119119
120120- Go 1.24 or later
121121- Make (optional, for convenience)
122122
123- # ## Building
123+ # ## 5.2. Building
124124
125125` ` ` bash
126126# Install dependencies
@@ -136,7 +136,7 @@ make dev
136136make build-all
137137` ` `
138138
139- # ## Testing
139+ # ## 5.3. Testing
140140
141141` ` ` bash
142142# Run tests
@@ -152,7 +152,7 @@ make lint
152152make fmt
153153` ` `
154154
155- # ## Project Structure
155+ # ## 5.4. Project Structure
156156
157157` ` ` bash
158158yoda
176176└── README.md # This file
177177` ` `
178178
179- # # Architecture
179+ # # 6. Architecture
180180
181181Yoda follows a modular architecture :
182182
@@ -186,31 +186,31 @@ Yoda follows a modular architecture:
186186- **Data Layer**: SQLite for local storage
187187- **AI Backend**: Separate service for AI functionality (planned)
188188
189- # # Roadmap
189+ # # 7. Roadmap
190190
191- # ## Phase 1: Core Infrastructure ✅
191+ # ## 7.1. Phase 1: Core Infrastructure ✅
192192- [x] Go CLI framework setup
193193- [x] Basic plugin system
194194- [x] Configuration management
195195- [x] Database integration
196196
197- # ## Phase 2: AI Integration (In Progress)
197+ # ## 7.2. Phase 2: AI Integration (In Progress)
198198- [ ] Ollama integration service
199199- [ ] AI command interface
200200- [ ] Context management
201201- [ ] Code generation
202202
203- # ## Phase 3: Plugin Ecosystem
203+ # ## 7.3. Phase 3: Plugin Ecosystem
204204- [ ] External plugin loading
205205- [ ] Plugin marketplace
206206- [ ] AI-powered plugin generation
207207- [ ] Security framework
208208
209- # # Contributing
209+ # # 8. Contributing
210210
211211We welcome contributions! Please see our [contributing guidelines](CONTRIBUTING.md) for details.
212212
213- # ## Development Workflow
213+ # ## 8.1. Development Workflow
214214
2152151. Fork the repository
2162162. Create a feature branch
@@ -219,9 +219,9 @@ We welcome contributions! Please see our [contributing guidelines](CONTRIBUTING.
2192195. Run `make test` and `make lint`
2202206. Submit a pull request
221221
222- # # Troubleshooting
222+ # # 9. Troubleshooting
223223
224- # ## Common Issues
224+ # ## 9.1. Common Issues
225225
226226**Database Connection Error**
227227```
@@ -235,21 +235,21 @@ Run `yoda init` to create the default configuration.
235235**Plugin Loading Issues**
236236Try `yoda plugin refresh` to reload the plugin registry.
237237
238- ## License
238+ ## 10. License
239239
240240This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
241241
242- ## Related Projects
242+ ## 11. Related Projects
243243
244244- [Yoda v2](https://github.com/94solutions/yoda/tree/v2) - Python implementation
245245- [Ollama](https://ollama.com) - Local LLM runtime
246246- [Cobra](https://github.com/spf13/cobra) - CLI framework
247247
248- ## Support
248+ ## 12. Support
249249
250- - 📚 [Documentation](https://94solutions.github.io/yoda)
251- - 🐛 [Issue Tracker](https://github.com/94solutions/yoda/issues)
252- - 💬 [Discussions](https://github.com/94solutions/yoda/discussions)
250+ - [Documentation](https://94solutions.github.io/yoda)
251+ - [Issue Tracker](https://github.com/94solutions/yoda/issues)
252+ - [Discussions](https://github.com/94solutions/yoda/discussions)
253253
254254---
255255
0 commit comments