3494f6b40d
All checks were successful
CI / build (push) Successful in 2m37s
- Add AES-256-GCM encryption for API keys (internal/secret) - Add dangerous command detection in terminal - Add muyue doctor command for system health checks - Add scanner TTL cache, orchestrator history mutex, shared HTTP client - Deduplicate MCP config generation, refactor skills YAML parser - Add XDG-compliant config dir with legacy migration - Add cleanup on all TUI quit paths - Add 8 test files (config, workflow, skills, orchestrator, version, platform, scanner, secret) - Update CI to actions/setup-go@v5 - Add CHANGELOG.md, update README and Makefile 🤖 Generated with Crush Assisted-by: GLM-5.1 via Crush <crush@charm.land>
126 lines
3.5 KiB
Markdown
126 lines
3.5 KiB
Markdown
# muyue
|
|
|
|
AI-powered development environment assistant by **La Légion de Muyue**.
|
|
|
|
## What it does
|
|
|
|
`muyue` is a single binary that transforms your entire development environment:
|
|
|
|
- **Scans** your system for tools, runtimes, and configs
|
|
- **Installs** missing tools automatically (Crush, Claude Code, BMAD, Starship, runtimes...)
|
|
- **Updates** everything in the background
|
|
- **Profiles** you on first run to personalize the experience
|
|
- **Unifies** control of Crush and Claude Code from one TUI
|
|
- **Orchestrates** AI agents via MiniMax M2.7
|
|
- **Customizes** your terminal prompt (branch, commits, language, etc.)
|
|
- **Configures** MCP servers, LSPs, and skills automatically
|
|
- **Previews** HTML/visual outputs in your browser
|
|
|
|
## Tech Stack
|
|
|
|
- **Go** — single binary, no dependencies
|
|
- **Charm** — Bubble Tea, Lip Gloss, Huh (TUI, styling, forms)
|
|
- **Starship** — terminal prompt customization
|
|
- **MiniMax M2.7** — AI orchestration
|
|
- **BMAD-METHOD** — structured development workflows
|
|
|
|
## Install
|
|
|
|
```bash
|
|
go build -o muyue ./cmd/muyue/
|
|
```
|
|
|
|
Or with Make:
|
|
|
|
```bash
|
|
make build
|
|
make install-local
|
|
```
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
muyue # Start interactive TUI
|
|
muyue scan # Scan system
|
|
muyue install # Install missing tools
|
|
muyue update # Check and apply updates
|
|
muyue setup # Run setup wizard
|
|
muyue config # Show configuration
|
|
muyue doctor # Diagnose configuration issues
|
|
muyue version # Show version
|
|
```
|
|
|
|
### LSP Management
|
|
|
|
```bash
|
|
muyue lsp scan # Scan for installed LSP servers
|
|
muyue lsp install # Install LSPs for configured languages
|
|
muyue lsp install gopls # Install a specific LSP
|
|
```
|
|
|
|
### MCP Server Configuration
|
|
|
|
```bash
|
|
muyue mcp config # Configure MCP servers for Crush and Claude Code
|
|
muyue mcp scan # Scan available MCP servers
|
|
```
|
|
|
|
### Skills Management
|
|
|
|
```bash
|
|
muyue skills list # List installed skills
|
|
muyue skills init # Install built-in skills
|
|
muyue skills show <name> # Show skill details
|
|
muyue skills generate <name> <desc> [crush|claude|both] # AI-generate a skill
|
|
muyue skills deploy # Deploy skills to Crush and Claude Code
|
|
muyue skills delete <name> # Delete a skill
|
|
```
|
|
|
|
## TUI Controls
|
|
|
|
| Key | Action |
|
|
|-----|--------|
|
|
| `Ctrl+T` | Open tab switcher |
|
|
| `Tab` / `Shift+Tab` | Cycle tabs |
|
|
| `Ctrl+C` | Quit confirmation |
|
|
| `i` (Dashboard) | Install missing tools |
|
|
| `u` (Dashboard) | Check for updates |
|
|
| `s` (Dashboard) | Rescan system |
|
|
| `a` (Workflow) | Approve plan |
|
|
| `r` (Workflow) | Reject plan |
|
|
| `g` (Workflow) | Generate plan |
|
|
| `n` (Workflow) | Next step |
|
|
| `x` (Workflow) | Cancel workflow |
|
|
|
|
### Chat Commands
|
|
|
|
- `/plan <goal>` — Start a structured Plan→Execute workflow
|
|
|
|
## Configuration
|
|
|
|
Config stored at `$XDG_CONFIG_HOME/muyue/config.yaml` (defaults to `~/.config/muyue/config.yaml`).
|
|
|
|
API keys are encrypted at rest using AES-GCM with a machine-local key stored in `~/.muyue_key`.
|
|
|
|
First run launches an interactive profiling wizard that:
|
|
1. Asks your name, pseudo, email
|
|
2. Detects your languages and editor
|
|
3. Chooses your AI provider
|
|
4. Scans your system
|
|
5. Installs missing tools
|
|
|
|
## Security
|
|
|
|
- API keys are encrypted at rest (AES-256-GCM) with a per-machine key
|
|
- Config files use restrictive permissions (0600)
|
|
- MCP config files use restrictive permissions (0600)
|
|
- Integrated terminal blocks dangerous commands (rm -rf /, mkfs, fork bombs, etc.)
|
|
|
|
## Cross-Platform
|
|
|
|
Built for Linux (primary), macOS, and Windows. WSL supported.
|
|
|
|
## License
|
|
|
|
MIT
|