Skip to content

Latest commit

 

History

History
55 lines (43 loc) · 5.11 KB

README.md

File metadata and controls

55 lines (43 loc) · 5.11 KB

Shou documentation

English | 简体中文

Shou provides storage analysis, reviewable cleanup and reusable rules. AI investigation is optional; deterministic services own validation, confirmation and execution.

Current platform status

Area Status
macOS SwiftUI/AppKit application, Swift domain services and independent CLI have source implementations; acceptance remains evidence-specific
Windows C# / .NET 10 LTS / WinUI 3 portable previews; x64/ARM64 native suites and window startup passed (SYNC.md); full UI and signed distribution pending
Runtime languages Simplified Chinese and English
Documentation 11 README languages; English and Simplified Chinese technical editions

For users and product contributors

Goal Read
Install and enable scanning Installation and access
Understand product scope PRD → Daily cleanup → User stories
Explore storage Space Analysis → Developer scenarios
Manage applications and developer projects Apps & Projects
Manage developer environments and AI software Developer Tools, AI Workbench, Full capability map, Per-software adapters
Inspect live resources and processes System monitor and desktop summaries
Manage applications or startup Application cleanup, Update discovery and software upgrades, Startup
Understand AI and rules AI journeys, Rule specification
Understand safety and results Cleanup safety, Progress

For engineers and AI development

Task Required reading
Establish module ownership System architecture → Platform boundaries
Implement a workflow Flows and sequences → Data contracts
Build the Windows application Windows overview → Native implementation plan → SYNC.md
Build and validate macOS Development → Acceptance
Plan delivery Implementation plan, Capability ownership, Cleanup delivery
Plan the next release Capability improvements, priorities and development packages
Diagnose and use terminal support Read-only reports, privacy and shell completion
Implement native presentation Interface design, macOS experience, Localization
Improve scan and deletion performance Implementation and measurements, Research report, Architecture proposal, Space investigation
Work on AI AI architecture → Implementation boundaries → Acceptance
Integrate external agents CLI contract, Agent integration, Skill distribution
Maintain rules Schema, Rule coverage
Release Signing, packaging and updates
Distribute the CLI through npm Unified npm entry and platform packages

Documentation contract

The PRD owns scope; rules own matching semantics; safety constrains all entry points; data contracts own identities/states; CLI documentation owns public machine operations. Native implementation plans own module and toolchain decisions. Keep each fact in its owning document and link to it.

Read the relevant contracts before code changes. Implement the smallest complete slice, update shared resources through their source, and record actual tests with revision, OS, architecture and limitations. Update both technical editions and the platform ledger together. Source, build success, runtime behavior and release acceptance are separate statuses.

MySQL administration: instance, schema, account, configuration and backup contract.