Skip to content

Latest commit

 

History

History

README.md

Kumo Technical Documentation

Kumo is a native macOS client for Mihomo. The first version focuses on a calm daily-use interface, a shared control layer, and an agent-friendly CLI. Advanced networking features remain discoverable, but they are not placed in the primary workflow.

Domain Map

  • Product — product scope, daily workflow, and information architecture.
  • Interfaces — macOS SwiftUI UI, menu/window surfaces, CLI, and agent-control surfaces.
  • Core — shared control layer, Mihomo runtime, profiles, and generated runtime configuration.
  • Operations — app bundle integration, permissions, persistence, logging, and release management.
  • Quality — testing strategy, verification commands, and manual QA checklist.
  • Roadmap — service-mode direction and Sparkle parity tracking.
  • Implementation Standards — focused implementation standards that cut across domains.

Current Source Layout

Sources/
  KumoCoreKit/   Shared domain, runtime, controller, system integration code
  KumoCLI/       Command-line frontend for humans and agents
  KumoApp/       SwiftUI macOS frontend
Tests/
  KumoCoreTests/ Unit tests for the shared control layer

Architectural Principle

The GUI, CLI, and future service mode must share the same domain behavior. UI surfaces should call KumoCoreKit rather than reimplementing Mihomo lifecycle, profile generation, or system proxy logic.