carbon-mac-copy-cloner

node-ccc-bridge (Carbon Copy Cloner SDK)

A professional Node.js SDK for programmatically managing Carbon Copy Cloner 7 backup tasks, monitoring snapshot health, and verifying disk clones.

Overview

The node-ccc-bridge provides a high-level API for integration with the Carbon Copy Cloner (CCC) task engine. It allows developers to automate backups, manage APFS snapshots, and monitor backup health directly from Node.js applications.

Key Features

• 💾 Task Automation: Start, stop, and schedule CCC backup tasks programmatically.
• 📸 Snapshot Management: List, verify, and prune APFS snapshots.
• 🩺 Health Monitoring: Access real-time backup audits and activity oversight.
• 🔐 Secure Execution: Built-in installer for the CCC Privileged Helper Tool.

Installation

This package is intended for use in environments where Carbon Copy Cloner 7 is installed.

npm install carbon-mac-copy-cloner@latest
npx carbon-mac-copy-cloner

Getting Started

const { CCCBridge } = require('carbon-mac-copy-cloner');

// Initialize the bridge (requests elevation for the Privileged Helper Tool)
const bridge = new CCCBridge();

async function runBackup() {
    console.log("Analyzing disk health...");
    const task = await bridge.getTask('Daily Bootable Clone');
    
    // Start the backup task
    await task.start();
    
    task.on('progress', (p) => {
        console.log(`Cloning: ${p.percent}% - ${p.currentFile}`);
    });
}

Security Model

To protect system integrity, Carbon Copy Cloner requires a Privileged Helper Tool for certain operations (e.g., kernel-level filesystem access, bypassing TCC constraints). The first time you initialize the bridge, you will be prompted to authorize the installation of com.bombich.ccc.helper.

Documentation

For full API documentation and advanced usage, visit the Bombich Developer Portal.

License

Copyright © 2024 Bombich Software, Inc. All rights reserved. Code examples provided under MIT license.