Skip to content

Repository files navigation

Sync Project Metadata

npm version CI License: MIT Support on SupportKori

Install a portable agent skill that audits project identity and release metadata, reports drift, and synchronizes local files only when requested.

The skill is designed for both OpenAI Codex and Claude Code. It treats package manifests and other explicit configuration as evidence, distinguishes deterministic mismatches from manual review, and does not publish, push, tag, deploy, or edit external services.

Install

From this source checkout

Requires Node.js 18 or newer.

npm ci
npm test
node ./bin/sync-project-metadata.js --target codex --scope project

This installs the skill into .agents/skills/sync-project-metadata in the current project.

From npm

Codex:

npx --yes --package=sync-project-metadata@latest sync-project-metadata --target codex

Claude Code:

npx --yes --package=sync-project-metadata@latest sync-project-metadata --target claude

Both:

npx --yes --package=sync-project-metadata@latest sync-project-metadata --target both

Restart the relevant agent after installation so it discovers the skill. Invoke it as $sync-project-metadata in Codex or /sync-project-metadata in Claude Code.

What it does

  • Establishes the authoritative source for names, versions, descriptions, URLs, install commands, and compatibility claims
  • Audits repeated metadata across manifests, lockfiles, skill metadata, documentation, deployment files, and catalogs
  • Classifies mismatches, stale values, unsupported claims, and missing fields
  • Synchronizes local files in evidence-first order when explicitly requested
  • Re-runs focused validation and reports unresolved ambiguity
  • Includes a deterministic Node.js metadata auditor for Node projects

The bundled auditor covers deterministic relationships only. Semantic description equivalence, compatibility language, generated surfaces, and fields that are not repeated still require agent review.

Installer options

--target <codex|claude|both>  Required installation target
--scope <user|project>        Install scope; defaults to user
--path <directory>            Exact custom skills root for one target
--dry-run                     Preview destinations without writing
--force                       Replace an existing installation
--help                        Show help
--version                     Show package version

User installs go to ~/.agents/skills for Codex and ${CLAUDE_CONFIG_DIR:-~/.claude}/skills for Claude Code. Project installs go to .agents/skills and .claude/skills in the current directory.

The installer refuses duplicate installations unless --force is supplied, rejects unsafe symlink or non-directory destinations, and stages replacements before swapping them into place.

How installation works

The npm executable copies the portable skills/sync-project-metadata directory into the selected host's skill root. The host then loads SKILL.md; the installer does not run the metadata auditor against a project or change project files during installation.

Examples

Audit without editing:

Use $sync-project-metadata to audit this project and report metadata drift.

Synchronize local files:

Use /sync-project-metadata to align the local package, lockfile, skill metadata, and README with the verified project identity.

Requirements and limits

  • Node.js 18 or newer is required for the installer and bundled audit script.
  • The agent needs filesystem access to the project under review.
  • Native project tools may be required to regenerate lockfiles or generated metadata.
  • External publication and service mutations remain outside this skill.
  • Ambiguous identity, ownership, licensing, public URLs, or compatibility policy require user direction.

Development

npm ci
npm test
npm run pack:check

The published archive intentionally contains only the installer, the nested skill, this README, the license, and package metadata. Tests are excluded.

npm test exercises the installer contract, exact-path installation, duplicate protection, forced replacement, dry-run behavior, project installation, and unsafe destinations. npm run pack:check previews the npm archive, and prepublishOnly runs both checks before publication.

Updating and removing

Rerun the @latest installation command with --force to replace an older installation. To uninstall, remove only the sync-project-metadata directory from the relevant user or project skill root listed above.

Contributing

Read CONTRIBUTING.md for requirements, the local workflow, required checks, and pull-request guidance.

Support and security

Read SUPPORT.md and use GitHub Issues for reproducible bugs and focused requests. Report vulnerabilities privately according to SECURITY.md, never through a public issue. The SupportKori link is funding, not technical support.

Project links

Funding

Optional support through SupportKori helps maintain the workflow and its verification guidance.

Author

Built and maintained by Montasim.

License

Sync Project Metadata is available under the MIT License.

About

Agent skill for Codex and Claude Code that audits and synchronizes project metadata across manifests, documentation, releases, and catalogs.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages