Commands
setup
Initialize a template repository with .ziku/ziku.jsonc
Initialize a template repository with .ziku/ziku.jsonc (setup vdev)
USAGE setup [OPTIONS] [DIR]
ARGUMENTS
DIR Template repository directory (Default: .)
OPTIONS
--remote Create a PR to set up a remote template repository instead of local (Default: false)
--from=<from> Remote template repository as owner/repo (used with --remote)
-n, --dryRun Preview what would be created, without writing files or opening a PR (Default: false)
-y, --yes Skip prompts (with --remote, the PR is opened without asking to confirm) (Default: false)init
Apply dev environment template to your project
Apply dev environment template to your project (ziku vdev)
USAGE ziku [OPTIONS] [DIR]
ARGUMENTS
DIR Target directory (Default: .)
OPTIONS
--force Approve overwriting existing files with the template version (Default: false)
-y, --yes Skip prompts (apply every template directory; existing files are kept, not overwritten) (Default: false)
-d, --dirs=<dirs> Comma-separated directory names to apply (non-interactive)
-s, --overwrite-strategy=<overwrite_strategy> Overwrite strategy: overwrite, skip, or prompt
--from=<from> Template source as owner/repo (e.g., my-org/my-templates)
--from-dir=<from_dir> Local directory to use as template source (skips GitHub download)
-n, --dryRun Preview which files would be created/overwritten, without writing them (Default: false)push
Push local changes to the template (PR for GitHub, direct copy for local)
Push local changes to the template (PR for GitHub, direct copy for local) (push)
USAGE push [OPTIONS] [DIR]
ARGUMENTS
DIR Project directory (Default: .)
OPTIONS
-n, --dryRun Preview only, don't push (Default: false)
-m, --message=<message> PR title (GitHub only)
-y, --yes Skip prompts (untracked files are reported and left out instead of being selected for tracking) (Default: false)
--edit Edit PR title and description before creating (GitHub only) (Default: false)
--files=<files> Comma-separated file paths to include (skips file selection prompt)
--includeDeletions Include locally deleted files (default: unselected in interactive mode) (Default: false)pull
Pull latest template updates
Pull latest template updates (pull)
USAGE pull [OPTIONS] [DIR]
ARGUMENTS
DIR Project directory (Default: .)
OPTIONS
-f, --force Approve deleting local files that were removed from the template (Default: false)
-y, --yes Skip prompts (files removed from the template are kept, not deleted) (Default: false)
--continue Continue a paused merge (asks which version to keep for files that could not be auto-merged) (Default: false)
-n, --dryRun Preview changes without applying them (Default: false)diff
Show differences between local and template
Show differences between local and template (diff)
USAGE diff [OPTIONS] [DIR]
ARGUMENTS
DIR Project directory (Default: .)
OPTIONS
-v, --verbose Show detailed diff (Default: false)status
Show pending pull/push counts and recommend next action
Show pending pull/push counts and recommend next action (status)
USAGE status [OPTIONS] [DIR]
ARGUMENTS
DIR Project directory (Default: .)track
Add file patterns to the tracking whitelist in ziku.jsonc
Add file patterns to the tracking whitelist in ziku.jsonc (track)
USAGE track [OPTIONS] [PATTERNS]
ARGUMENTS
PATTERNS File paths or glob patterns to track (e.g., .cloud/rules/*.md)
OPTIONS
-d, --dir=<dir> Project directory (default: current directory) (Default: .)
-l, --list List all currently tracked patterns (Default: false)
-n, --dryRun Preview patterns that would be tracked, without writing (Default: false)aggregate
Inventory unsynced diffs across all repositories using this template (read-only; does not push or consolidate changes)
Inventory unsynced diffs across all repositories using this template (read-only; does not push or consolidate changes) (aggregate)
USAGE aggregate [OPTIONS] [DIR]
ARGUMENTS
DIR Template repository directory (Default: .)
OPTIONS
--owner=<owner> GitHub owner to search for template usage (default: origin owner)
--since=<since> Only include repositories with pending-push/conflict changes on or after this date/time (ISO 8601; interpreted as UTC unless an explicit offset is given)
--json Print the JSON report to stdout (no decoration; safe to pipe) (Default: false)
--out=<out> Write the JSON report to this file path
--include-archived Include archived repositories (Default: false)
--concurrency=<concurrency> Number of repositories to process concurrently (default: 4)
--max-candidates=<max_candidates> Maximum number of candidate repositories to check (default: 30, further reduced when the current GitHub API rate limit is low)
--recent-days=<recent_days> Only consider repositories pushed within this many days (default: 90; distinct from --since, which filters by the last commit date of pending-push/conflict files)What You Get
The files you get depend on the patterns configured in your template's .ziku/ziku.jsonc. After running ziku init, your selected patterns are saved in your own .ziku/ziku.jsonc — you can customize them anytime with ziku track.
ziku also creates:
.ziku/ziku.jsonc— Your sync patterns (which files to include/exclude).ziku/lock.json— Sync state + template source (hashes, base refs, source info)