Skip to content
Arashi logoArashi

sync Command

What It’s For

Section titled “What It’s For”

Reconcile workspace state when repositories drift or after branch lifecycle changes.

What It Does

Section titled “What It Does”
  • Checks configured repositories against expected workspace metadata.
  • Refreshes repository/worktree alignment.
  • Surfaces mismatches so maintainers can resolve them quickly.

Usage

Section titled “Usage”
Terminal window
arashi sync [options]

Key Options

Section titled “Key Options”
  • --only <repos> sync comma-separated repository names only.
  • -v, --verbose show detailed per-repository sync output.
  • --json output machine-readable sync results.

Examples

Section titled “Examples”
Terminal window
# Sync all managed repositories
arashi sync


# Sync selected repositories
arashi sync --only api,web


# Sync with per-repo details
arashi sync --verbose


# Sync selected repositories and emit JSON
arashi sync --only api,web --json

Notes

Section titled “Notes”
  • sync aligns repositories to the parent repository’s current branch.
  • When needed, it can create missing target branches in child repositories.
  • JSON mode keeps stdout parseable as a single result document for programmatic callers.

Agent Notes

Section titled “Agent Notes”
  • Use arashi sync when branch/worktree state has drifted and you need the child repos aligned to the current parent branch.
  • Inspect arashi status before and after sync so any remaining mismatches are visible before implementation or handoff.
  • Avoid using sync as a substitute for understanding dirty worktrees; resolve or preserve local changes deliberately.
Section titled “Related Commands”