Skip to content

Repository files navigation

modeskill cover

Modeskill

Modeskill is a public, local-first Skill that helps coding agents compare UI and user-visible product behavior across related projects without turning accidental code patterns into global rules.

It discovers projects inside a user-authorized Workspace, builds evidence from read-only references, and classifies findings as inherited, adapted, project-specific, unresolved, deprecated, or out-of-scope.

Modeskill is a consistency workflow for coding agents, not a design-system package or a project architecture authority.

Capabilities

The Git-synced v0.2 modules provide:

  • ui-consistency: UI and interaction evidence, project profiles, and consistency reports.
  • product-consistency: read-only checks for PWA, About, cache update, account-flow, and project-memory behavior.
  • security-review: evidence-backed static review checklists; this is not a security certification.
  • shared: Workspace discovery, authorization, path safety, evidence rules, schemas, and module routing.

Optional local-only modules can be registered under .local/modules/. Modeskill never claims that an optional module exists until its local registration and files resolve.

Authority and safety

Each target repository's own instructions, architecture, engineering standards, product specifications, workflows, and verified production evidence override Modeskill inference.

  • Reference projects are always read-only.
  • A target is read-only by default.
  • Target writing requires explicit-per-task policy, clear authorization in the current task, and actual runtime write access.
  • Workspace configuration does not grant operating-system access or write authorization.
  • Auth, identity, database, migration, deployment, product boundary, and production-fact decisions are deferred to the target project's authority sources.
  • Paths are resolved and checked against the authorized Workspace before access.
  • Credentials, production configuration, private project content, and local-only settings must not enter this public repository.

See Safety Boundaries for the full contract.

Installation

git clone https://github.com/jonsungo/modeskill.git
cd modeskill
mkdir -p ~/.agents/skills
ln -s /path/to/modeskill/.agents/skills/modeskill ~/.agents/skills/modeskill

Invoke the Skill with $modeskill. Other compatible coding agents can read .agents/skills/modeskill/SKILL.md directly and follow the selected module instructions.

Local configuration

Start the loopback-only Configurator:

python3 .agents/skills/modeskill/configurator/server.py

Then open http://127.0.0.1:8765/. The Configurator stores machine-specific Workspace and optional module settings under .local/, which is excluded from Git and is not restored by cloning the repository.

Validation

python3 scripts/validate_modeskill.py
python3 -m unittest discover -s tests

CI runs the same repository validation and test suite. The tests use synthetic examples and temporary directories rather than real business projects.

Documentation

Repository map

.agents/skills/modeskill/  Skill entry, shared rules, modules, schemas, scripts
docs/                     Maintainer and usage documentation
examples/                 Synthetic reference and target projects
scripts/                  Repository validation
tests/                    Automated behavior and safety checks

Status

Modeskill v0.2 is suitable for local discovery and evidence-backed, read-only analysis. Automatic design-system extraction, drift monitoring, remediation, and unattended project modification are not current capabilities.

License

MIT. See LICENSE.

About

A local-first Skill for helping coding agents keep UI and interaction patterns consistent across multiple projects.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages