kanka-sync

Sync local HTML entity files with the Kanka API.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/ervwalter/kanka-entities --skill kanka-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: kanka-sync
Source: https://github.com/ervwalter/kanka-entities/tree/main/.claude/skills/kanka-sync
Command: npx skills add https://github.com/ervwalter/kanka-entities --skill kanka-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Run and diagnose the Kanka entity sync script to keep local files in sync with the remote campaign.

Core Features & Use Cases

  • Two-way sync between local HTML entity files and Kanka, with preview and full-sync options.
  • Conflict handling via sidecar files when both local and remote edits occur.
  • Safe execution: run from the repository root and leverage dry-run and delete options to manage changes.

Quick Start

From the repository root, run the script to sync all entities with the latest Kanka data.

Frequently Asked Questions about kanka-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I sync local HTML files with the Kanka API?

To sync local HTML files with the Kanka API, run the sync script from the repository root using uv run --upgrade scripts/sync_kanka.py. This automates two-way data synchronization between your local campaign entities and the remote Kanka API.

How does conflict resolution work during a two-way Kanka sync?

Conflict resolution during a two-way Kanka sync is handled using sidecar .kanka.html files. When both local and remote entity edits occur, these sidecar files capture conflicting data to prevent overwriting uncommitted changes.

Can I preview Kanka entity changes before applying them?

Yes, you can preview Kanka entity changes by running the sync script with the --dry-run flag. This allows you to safely review local and remote data modifications before executing a full-sync operation.

What is the correct command to run the Kanka sync script?

The correct command to run the Kanka sync script is uv run --upgrade scripts/sync_kanka.py, executed from the repository root. You can append --full-sync, --dry-run, or --delete flags to manage specific sync operations.

How do I delete outdated entities during a Kanka sync?

To delete outdated entities during a Kanka sync, include the --delete flag when running the script. This ensures that items removed from the remote campaign are also deleted from your local files during the synchronization process.