Skip to content
Arashi logoArashi

push Command

What It’s For

Section titled “What It’s For”

Publish the current coordinated branch before opening related PRs across the parent repo and any changed child repositories.

What It Does

Section titled “What It Does”
  • Evaluates the current branch in the parent workspace and configured child repositories.
  • Pushes repositories with publishable local branch commits.
  • Skips untouched, already up-to-date, detached, or unconfigured repositories with clear reasons.
  • Avoids creating remote branches for child repositories that were intentionally untouched.

Usage

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

Key Options

Section titled “Key Options”
  • --only <repo> include only a named repository. Repeat it to select multiple repositories.
  • --group <group> include only repositories in the requested group. Repeat for multiple groups.
  • --set-upstream publish new branches and configure upstream tracking.
  • --dry-run preview planned pushes without updating remotes.
  • --json output a single machine-readable result envelope.

Examples

Section titled “Examples”
Terminal window
# Publish eligible repositories with existing upstreams
arashi push


# Publish a new coordinated branch
arashi push --set-upstream


# Publish only the CLI repo
arashi push --only arashi --set-upstream


# Publish changed documentation repositories only
arashi push --group docs --set-upstream


# Preview before publishing
arashi push --set-upstream --dry-run


# Use automation-safe output
arashi push --set-upstream --json

Notes

Section titled “Notes”
  • push does not open pull requests; it only publishes branches.
  • Repositories without upstream tracking are skipped unless --set-upstream is supplied.
  • Dry-run is a local preview and does not contact or mutate remotes.
  • --group narrows publishing to configured semantic sets; when combined with --only, both filters must match.
  • JSON mode keeps stdout parseable as one envelope and reports skipped repositories as structured warnings.

Agent Notes

Section titled “Agent Notes”
  • Use arashi push --set-upstream after committing implementation changes and before opening related PRs.
  • Use --group <group> for known semantic sets and --only <repo> for focused child-repo PRs instead of pushing every coordinated worktree.
  • Do not manufacture remote branches for clean, untouched child repositories just because the coordinated branch exists locally.
Section titled “Related Commands”