Skip to content

Configuration

registry-sync works out of the box with sensible defaults, but you can customize its behavior with a configuration file or use it programmatically as a library.

Place a registry-sync.config.json in your project root:

{
"org": "mcp-tool-shop-org",
"exclude": [".github", "brand"],
"targets": {
"npm": { "enabled": true },
"ghcr": { "enabled": true }
}
}
FieldTypeDescription
orgstringGitHub org to scan
excludestring[]Repo names to skip during audit
targets.npm.enabledbooleanEnable npm registry auditing
targets.ghcr.enabledbooleanEnable GHCR registry auditing

If no config file is found, registry-sync falls back to defaults. The --org CLI flag overrides the config file value.

registry-sync exports its core functions for use in your own scripts and automation:

import { audit, plan, loadConfig } from '@mcptoolshop/registry-sync';
const config = loadConfig();
const auditResult = await audit(config);
const planResult = plan(auditResult, config);
console.log(planResult.summary);
// { publish: 9, update: 1, scaffold: 26, prune: 3, skip: 45 }
FunctionDescription
loadConfig()Reads registry-sync.config.json from the current directory, returns defaults if not found
audit(config)Runs the full audit, returns the presence matrix
plan(auditResult, config)Generates the action plan from audit results