Skip to content

README.md

Latest commit

聽

History

History
53 lines (41 loc) 路 2.15 KB

README.md

File metadata and controls

53 lines (41 loc) 路 2.15 KB
Raw

aps documentation

aps is a Swift CLI for exploring AppState outside SwiftUI and exposing typed state to terminal users, agents, and CI.

Start here

Goal Read
Install and use the CLI Project README
Choose an integration pattern Projects, agents, and CI
Run complete workflows Examples
Understand user-defined keys Dynamic schema design
Decide whether the next tag is ready Release readiness
Operate signed releases and recover provenance Release provenance
Understand platform coverage Windows and tri-OS readiness
Review non-goals SyncState spike and ModelState spike
Inspect normative behavior specs/aps-cli and specs/state-store

Mental model

schema.json
    |
    +-- State ----------- process-local value
    +-- StoredState ----- UserDefaults-backed value
    +-- FileState ------- JSON file
    +-- EncryptedFile --- encrypted envelope
    +-- Slice ----------- typed field projection
    |
    +-- human output / JSON / JSONL

The user schema is mutable data. The compiled CLI contract is versioned separately. aps schema --json joins both views so an agent can discover commands, error codes, output shapes, and the current key inventory in one request.

Working on aps

Use the repository-native verification surface:

fledge lanes run verify
fledge trust verify

Code and specs change together. Follow AGENTS.md for Swift conventions, SpecSync workflow, ticket claiming, and release requirements.

Documentation principles

  • State current behavior, including limitations.
  • Keep machine-contract examples byte-accurate.
  • Separate shipped behavior from proposed hardening.
  • Link design decisions to normative SpecSync requirements.
  • Distinguish soft pull request provenance from the strict release publication gate.
  • Do not describe partial platform distribution as stronger than it is.