Skip to content

How it Works ​

mermaid
graph TB

  subgraph Template["Template Repository"]
    T_ZIKU_ZIKU_JSONC[".ziku/ziku.jsonc"]
    T_SYNCED_FILES["synced files"]
    T_README_MD["README.md"]
  end

  subgraph User["User Project"]
    U_ZIKU_ZIKU_JSONC[".ziku/ziku.jsonc"]
    U_ZIKU_LOCK_JSON[".ziku/lock.json"]
    U_SYNCED_FILES["synced files"]
  end

  subgraph Consumers["Consumer Repositories"]
    R_ZIKU_LOCK_JSON[".ziku/lock.json"]
    R_ZIKU_ZIKU_JSONC[".ziku/ziku.jsonc"]
    R_SYNCED_FILES["synced files"]
  end

  setup([setup]) -->|create| T_ZIKU_ZIKU_JSONC
  init([init]) -.->|read| T_ZIKU_ZIKU_JSONC
  init -->|create| U_ZIKU_ZIKU_JSONC & U_ZIKU_LOCK_JSON & U_SYNCED_FILES
  pull([pull]) -.->|read| U_ZIKU_ZIKU_JSONC & U_ZIKU_LOCK_JSON & T_SYNCED_FILES
  pull -->|update| U_SYNCED_FILES & U_ZIKU_ZIKU_JSONC & U_ZIKU_LOCK_JSON
  push([push]) -.->|read| U_ZIKU_ZIKU_JSONC & U_ZIKU_LOCK_JSON & U_SYNCED_FILES & T_SYNCED_FILES
  push -->|update| U_ZIKU_ZIKU_JSONC & T_SYNCED_FILES & T_ZIKU_ZIKU_JSONC & T_README_MD & U_ZIKU_LOCK_JSON
  diff([diff]) -.->|read| U_ZIKU_ZIKU_JSONC & U_ZIKU_LOCK_JSON & U_SYNCED_FILES & T_SYNCED_FILES
  status([status]) -.->|read| U_ZIKU_ZIKU_JSONC & U_ZIKU_LOCK_JSON & U_SYNCED_FILES & T_SYNCED_FILES
  track([track]) -.->|read| U_ZIKU_ZIKU_JSONC
  track -->|update| U_ZIKU_ZIKU_JSONC
  aggregate([aggregate]) -.->|read| T_ZIKU_ZIKU_JSONC & R_ZIKU_LOCK_JSON & R_ZIKU_ZIKU_JSONC & T_SYNCED_FILES & R_SYNCED_FILES

The config file ​

Both the template and user project share the same .ziku/ziku.jsonc format — just include and exclude patterns:

jsonc
{
  "include": [".claude/rules/*.md", ".mcp.json", ".github/workflows/**"],
}

Command overview ​

CommandWho runs itWhat it does
setupTemplate authorInitialize a template repository
init (user project)Template userInitialize user project from template
pullTemplate userPull latest template updates to local project
pushTemplate userPush local changes to template (GitHub: PR / local: direct copy)
diffTemplate userShow differences between local and template
statusTemplate userShow pending pull/push counts and recommend next action
trackTemplate userAdd file patterns to the sync whitelist
aggregateTemplate authorInventory unsynced diffs across repositories using this template (read-only)

Template source info (owner/repo or local path) is stored in .ziku/lock.json, separate from patterns. When you pull, new patterns added to the template's .ziku/ziku.jsonc are automatically merged into yours.

Released under the MIT License.