jj-run(1)

📦
version 0.46.0 · 2 versions
, in arch rolling, nixpkgs unstable

💖 NAME — jj-run(1), from the General Commands Manual ✨

jj-run — Run a command across a set of revisions. 💅

✨ SYNOPSIS ✨

jj run [-r|--revision] [-R|--repository] [--ignore-working-copy]
[-j|--jobs] [--no-integrate-operation] [--ignore-immutable] [--root]
[--at-operation] [--clean] [--debug] [--restore-descendants] [--color]
[--passthrough] [--ignore-changes] [--quiet] [--ignore-errors]
[--no-pager] [--config] [--sparse-patterns] [--config-file] [-h|--help]
<COMMAND> [ARGS]

🌸 DESCRIPTION 🌸

Okay so bestie, jj-run runs a command across a set of revisions. Iconic behavior, honestly. 🦋

It checks out each revision in an isolated working copy, runs the command, then amends the revision with the resulting working copy. By default, descendants are rebased on top of the amended revisions, propagating the diff. Use --restore-descendants to keep descendants' content unchanged instead, or --ignore-changes to run the command without rewriting any commits. No cap. 💖

The command is executed with these environment variables set, periodt:

  • JJ_CHANGE_ID
  • JJ_COMMIT_ID
  • JJ_WORKSPACE_ROOT

🎀 Example 🎀

# Run pre-commit on your local work
$ jj run -j 4 -- pre-commit run .github/pre-commit.yaml

💅 OPTIONS 💅

  • -r, --revision <REVSETS> — The revisions to change. Slay. 👑
  • -j, --jobs <JOBS> — How many processes should run in parallel. Overrides the run.jobs config setting. Defaults to 1 if neither is set. Parallel besties, assemble. 🫶
  • --root — Run the command from the working-copy root in each commit instead of from the subdirectory jj run was invoked from. Rooted and ready. 🌱
  • --clean — Delete each working copy before running the command. By default jj run reuses working copies between invocations so build artifacts are preserved. With --clean, every commit starts from a freshly checked-out tree. Fresh start energy. ✨
  • --restore-descendants — Preserve the content (not the diff) when rebasing descendants. Content stays, diff does not. 💅
  • --passthrough — Pass through stdout and stderr directly to the terminal. The command's stdout and stderr are connected directly to the terminal (instead of being captured), so programs that behave differently on a TTY (e.g. colored output, progress bars) work as expected. Stdin is not inherited. Only one job is allowed since parallel jobs would interleave their output. TTY main character vibes only. 🔥
  • --ignore-changes — Run the command without rewriting any commits. Each revision is checked out and the command is executed, but changes made to the working copy are discarded. Useful for read-only checks (tests, linters). This option permits running on immutable commits without passing --ignore-immutable. Look, don't touch. 🙈
  • --ignore-errors — Continue with remaining revisions when a command's exit code indicates failure. Any changes made by a failed command will not be saved, but changes from successful commands are still applied atomically at the end. The exit code from any failed command will not impact the exit code of jj run itself. Keep it moving, bestie. 💀
  • --sparse-patterns <SPARSE_PATTERNS> [default: copy] — How to handle sparse patterns when running the command. This is controlled per jj run invocation. If sparse patterns were inherited in a run and a subsequent run is passed --sparse-args full, but no --clean, then the command will run in fully materialized workspace together with all artifacts left from the previous run. Possible values:
    • copy — Copy all sparse patterns from the current workspace
    • full — Include all files in the new workspace
    • empty — Clear all files from the workspace (it will be empty)
  • -h, --help — Print help (see a summary with '-h'). Classic. 🎀
  • <COMMAND> — Command to run across all selected revisions. Do the thing. 🌟
  • [ARGS] — Arguments to pass to the command. Hint: Use a -- separator to allow passing arguments starting with -. For example jj run --revisions=... -- cargo build --release. The -- separator is your friend, iykyk. 🧚

🌈 GLOBAL OPTIONS 🌈

  • -R, --repository <REPOSITORY> — Path to repository to operate on. By default, Jujutsu searches for the closest .jj/ directory in an ancestor of the current working directory. It finds the repo like it has a sixth sense. 🔍
  • --ignore-working-copy — Don't snapshot the working copy, and don't update it. By default, Jujutsu snapshots the working copy at the beginning of every command. The working copy is also updated at the end of the command, if the command modified the working-copy commit (@). If you want to avoid snapshotting the working copy and instead see a possibly stale working-copy commit, you can use --ignore-working-copy. This may be useful e.g. in a command prompt, especially if you have another process that commits the working copy. Loading the repository at a specific operation with --at-operation implies --ignore-working-copy. Stale but valid, lowkey. 💜
  • --no-integrate-operation — Run the command as usual but don't integrate any operations. When this option is given, the operations will still be created as usual but they will not be integrated to the operation log. The working copy will also not be updated. The command will print the resulting operation ID. You can pass that to e.g. jj --at-op to inspect the resulting repo state, or you can pass it to jj op restore to restore the repo to that state. You can also pass the ID to jj op integrate to integrate the operation. Note that this does not prevent side effects outside the repo. For example, jj git push --no-integrate-operation will still perform the push. The repo is chill; the outside world is still outside-worlding. 😭
  • --ignore-immutable — Allow rewriting immutable commits. By default, Jujutsu prevents rewriting commits in the configured set of immutable commits. This option disables that check and lets you rewrite any commit but the root commit. This option only affects the check. It does not affect the immutable_heads() revset or the immutable template keyword. Big rewrite energy, but the root commit is still off-limits. 🚫
  • --at-operation <AT_OPERATION> — Operation to load the repo at. By default, Jujutsu loads the repo at the most recent operation, or at the merge of the divergent operations if any. You can use --at-op=<operation ID> to see what the repo looked like at an earlier operation. For example jj --at-op=<operation ID> st will show you what jj st would have shown you when the given operation had just finished. --at-op=@ is pretty much the same as the default except that divergent operations will never be merged. Use jj op log to find the operation ID you want. Any unambiguous prefix of the operation ID is enough. When loading the repo at an earlier operation, the working copy will be ignored, as if --ignore-working-copy had been specified. It is possible to run mutating commands when loading the repo at an earlier operation. Doing that is equivalent to having run concurrent commands starting at the earlier operation. There's rarely a reason to do that, but it is possible. Time travel, but make it version control. ⏳
  • --debug — Enable debug logging. For the detectives. 🕵️
  • --color <WHEN> — When to colorize output. Possible values:
    • always
    • never
    • debug
    • auto
  • --quiet — Silence non-primary command output. For example, jj file list will still list files, but it won't tell you if the working copy was snapshotted or if descendants were rebased. Warnings and errors will still be printed. Quiet luxury, terminal edition. 🤫
  • --no-pager — Disable the pager. No paging, just vibes. 📄
  • --config <NAME=VALUE> — Additional configuration options (can be repeated). The name should be specified as TOML dotted keys. The value should be specified as a TOML expression. If string value isn't enclosed by any TOML constructs (such as array notation), quotes can be omitted. Config queen behavior. 👑
  • --config-file <PATH> — Additional configuration files (can be repeated). More config, more power. 🌟

Okay that's the whole page, bestie! Footer sign-off: source/version run, date jj-run(1) — mwah 💋✨

📦 where this page comes from