Programmatic API

Rulesync can be used as a library in your Node.js/TypeScript projects. The generate and importFromTool functions are available as named exports.

import { generate, importFromTool } from "rulesync";

// Generate configurations
const result = await generate({
  targets: ["claudecode", "cursor"],
  features: ["rules", "mcp"],
});
console.log(`Generated ${result.rulesCount} rules, ${result.mcpCount} MCP configs`);

// Import existing tool configurations into .rulesync/
const importResult = await importFromTool({
  target: "claudecode",
  features: ["rules", "commands"],
});
console.log(`Imported ${importResult.rulesCount} rules`);

generate(options?)

Generates configuration files for the specified targets and features.

Option	Type	Default	Description
targets	ToolTarget[]	from config file	Tools to generate configurations for
features	Feature[]	from config file	Features to generate
baseDirs	string[]	[process.cwd()]	Base directories for generation
configPath	string	auto-detected	Path to rulesync.jsonc
verbose	boolean	false	Enable verbose logging
silent	boolean	true	Suppress all output
delete	boolean	from config file	Delete existing files before generating
global	boolean	false	Generate global (user scope) configurations
simulateCommands	boolean	false	Generate simulated commands
simulateSubagents	boolean	false	Generate simulated subagents
simulateSkills	boolean	false	Generate simulated skills
dryRun	boolean	false	Show changes without writing files
check	boolean	false	Exit with code 1 if files are not up to date

importFromTool(options)

Imports existing tool configurations into .rulesync/ directory.

Option	Type	Default	Description
target	ToolTarget	(required)	Tool to import configurations from
features	Feature[]	from config file	Features to import
configPath	string	auto-detected	Path to rulesync.jsonc
verbose	boolean	false	Enable verbose logging
silent	boolean	true	Suppress all output
global	boolean	false	Import global (user scope) configurations