--- source: cli/tests/test_generate_md_cli_help.rs description: "AUTO-GENERATED FILE, DO NOT EDIT. This cli reference is generated by a test as an `insta` snapshot. MkDocs includes this snapshot from docs/cli-reference.md." --- # Command-Line Help for `jj` This document contains the help content for the `jj` command-line program. **Command Overview:** * [`jj`↴](#jj) * [`jj abandon`↴](#jj-abandon) * [`jj backout`↴](#jj-backout) * [`jj bookmark`↴](#jj-bookmark) * [`jj bookmark create`↴](#jj-bookmark-create) * [`jj bookmark delete`↴](#jj-bookmark-delete) * [`jj bookmark forget`↴](#jj-bookmark-forget) * [`jj bookmark list`↴](#jj-bookmark-list) * [`jj bookmark move`↴](#jj-bookmark-move) * [`jj bookmark rename`↴](#jj-bookmark-rename) * [`jj bookmark set`↴](#jj-bookmark-set) * [`jj bookmark track`↴](#jj-bookmark-track) * [`jj bookmark untrack`↴](#jj-bookmark-untrack) * [`jj commit`↴](#jj-commit) * [`jj config`↴](#jj-config) * [`jj config edit`↴](#jj-config-edit) * [`jj config get`↴](#jj-config-get) * [`jj config list`↴](#jj-config-list) * [`jj config path`↴](#jj-config-path) * [`jj config set`↴](#jj-config-set) * [`jj describe`↴](#jj-describe) * [`jj diff`↴](#jj-diff) * [`jj diffedit`↴](#jj-diffedit) * [`jj duplicate`↴](#jj-duplicate) * [`jj edit`↴](#jj-edit) * [`jj evolog`↴](#jj-evolog) * [`jj file`↴](#jj-file) * [`jj file chmod`↴](#jj-file-chmod) * [`jj file list`↴](#jj-file-list) * [`jj file show`↴](#jj-file-show) * [`jj file track`↴](#jj-file-track) * [`jj file untrack`↴](#jj-file-untrack) * [`jj fix`↴](#jj-fix) * [`jj git`↴](#jj-git) * [`jj git clone`↴](#jj-git-clone) * [`jj git export`↴](#jj-git-export) * [`jj git fetch`↴](#jj-git-fetch) * [`jj git import`↴](#jj-git-import) * [`jj git init`↴](#jj-git-init) * [`jj git push`↴](#jj-git-push) * [`jj git remote`↴](#jj-git-remote) * [`jj git remote add`↴](#jj-git-remote-add) * [`jj git remote list`↴](#jj-git-remote-list) * [`jj git remote remove`↴](#jj-git-remote-remove) * [`jj git remote rename`↴](#jj-git-remote-rename) * [`jj git remote set-url`↴](#jj-git-remote-set-url) * [`jj init`↴](#jj-init) * [`jj interdiff`↴](#jj-interdiff) * [`jj log`↴](#jj-log) * [`jj new`↴](#jj-new) * [`jj next`↴](#jj-next) * [`jj operation`↴](#jj-operation) * [`jj operation abandon`↴](#jj-operation-abandon) * [`jj operation diff`↴](#jj-operation-diff) * [`jj operation log`↴](#jj-operation-log) * [`jj operation restore`↴](#jj-operation-restore) * [`jj operation show`↴](#jj-operation-show) * [`jj operation undo`↴](#jj-operation-undo) * [`jj parallelize`↴](#jj-parallelize) * [`jj prev`↴](#jj-prev) * [`jj rebase`↴](#jj-rebase) * [`jj resolve`↴](#jj-resolve) * [`jj restore`↴](#jj-restore) * [`jj root`↴](#jj-root) * [`jj show`↴](#jj-show) * [`jj sparse`↴](#jj-sparse) * [`jj sparse edit`↴](#jj-sparse-edit) * [`jj sparse list`↴](#jj-sparse-list) * [`jj sparse reset`↴](#jj-sparse-reset) * [`jj sparse set`↴](#jj-sparse-set) * [`jj split`↴](#jj-split) * [`jj squash`↴](#jj-squash) * [`jj status`↴](#jj-status) * [`jj tag`↴](#jj-tag) * [`jj tag list`↴](#jj-tag-list) * [`jj util`↴](#jj-util) * [`jj util completion`↴](#jj-util-completion) * [`jj util gc`↴](#jj-util-gc) * [`jj util mangen`↴](#jj-util-mangen) * [`jj util markdown-help`↴](#jj-util-markdown-help) * [`jj util config-schema`↴](#jj-util-config-schema) * [`jj undo`↴](#jj-undo) * [`jj unsquash`↴](#jj-unsquash) * [`jj version`↴](#jj-version) * [`jj workspace`↴](#jj-workspace) * [`jj workspace add`↴](#jj-workspace-add) * [`jj workspace forget`↴](#jj-workspace-forget) * [`jj workspace list`↴](#jj-workspace-list) * [`jj workspace rename`↴](#jj-workspace-rename) * [`jj workspace root`↴](#jj-workspace-root) * [`jj workspace update-stale`↴](#jj-workspace-update-stale) ## `jj` Jujutsu (An experimental VCS) To get started, see the tutorial at https://martinvonz.github.io/jj/latest/tutorial/. **Usage:** `jj [OPTIONS] [COMMAND]` ###### **Subcommands:** * `abandon` — Abandon a revision * `backout` — Apply the reverse of a revision on top of another revision * `bookmark` — Manage bookmarks * `commit` — Update the description and create a new change on top * `config` — Manage config options * `describe` — Update the change description or other metadata * `diff` — Compare file contents between two revisions * `diffedit` — Touch up the content changes in a revision with a diff editor * `duplicate` — Create a new change with the same content as an existing one * `edit` — Sets the specified revision as the working-copy revision * `evolog` — Show how a change has evolved over time * `file` — File operations * `fix` — Update files with formatting fixes or other changes * `git` — Commands for working with Git remotes and the underlying Git repo * `init` — Create a new repo in the given directory * `interdiff` — Compare the changes of two commits * `log` — Show revision history * `new` — Create a new, empty change and (by default) edit it in the working copy * `next` — Move the working-copy commit to the child revision * `operation` — Commands for working with the operation log * `parallelize` — Parallelize revisions by making them siblings * `prev` — Change the working copy revision relative to the parent revision * `rebase` — Move revisions to different parent(s) * `resolve` — Resolve a conflicted file with an external merge tool * `restore` — Restore paths from another revision * `root` — Show the current workspace root directory * `show` — Show commit description and changes in a revision * `sparse` — Manage which paths from the working-copy commit are present in the working copy * `split` — Split a revision in two * `squash` — Move changes from a revision into another revision * `status` — Show high-level repo status * `tag` — Manage tags * `util` — Infrequently used commands such as for generating shell completions * `undo` — Undo an operation (shortcut for `jj op undo`) * `unsquash` — Move changes from a revision's parent into the revision * `version` — Display version information * `workspace` — Commands for working with workspaces ###### **Options:** * `-R`, `--repository ` — Path to repository to operate on By default, Jujutsu searches for the closest .jj/ directory in an ancestor of the current working directory. * `--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`. * `--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. * `--at-operation ` — Operation to load the repo at 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=` to see what the repo looked like at an earlier operation. For example `jj --at-op= 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. * `--debug` — Enable debug logging * `--color ` — When to colorize output (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. * `--no-pager` — Disable the pager * `--config-toml ` — Additional configuration options (can be repeated) ## `jj abandon` Abandon a revision Abandon a revision, rebasing descendants onto its parent(s). The behavior is similar to `jj restore --changes-in`; the difference is that `jj abandon` gives you a new change, while `jj restore` updates the existing change. If a working-copy commit gets abandoned, it will be given a new, empty commit. This is true in general; it is not specific to this command. **Usage:** `jj abandon [OPTIONS] [REVISIONS]...` ###### **Arguments:** * `` — The revision(s) to abandon Default value: `@` ###### **Options:** * `-s`, `--summary` — Do not print every abandoned commit on a separate line * `--restore-descendants` — Do not modify the content of the children of the abandoned commits ## `jj backout` Apply the reverse of a revision on top of another revision **Usage:** `jj backout [OPTIONS]` ###### **Options:** * `-r`, `--revisions ` — The revision(s) to apply the reverse of Default value: `@` * `-d`, `--destination ` — The revision to apply the reverse changes on top of Default value: `@` ## `jj bookmark` Manage bookmarks For information about bookmarks, see https://martinvonz.github.io/jj/latest/docs/bookmarks.md. **Usage:** `jj bookmark ` ###### **Subcommands:** * `create` — Create a new bookmark * `delete` — Delete an existing bookmark and propagate the deletion to remotes on the next push * `forget` — Forget everything about a bookmark, including its local and remote targets * `list` — List bookmarks and their targets * `move` — Move existing bookmarks to target revision * `rename` — Rename `old` bookmark name to `new` bookmark name * `set` — Create or update a bookmark to point to a certain commit * `track` — Start tracking given remote bookmarks * `untrack` — Stop tracking given remote bookmarks ## `jj bookmark create` Create a new bookmark **Usage:** `jj bookmark create [OPTIONS] ...` ###### **Arguments:** * `` — The bookmarks to create ###### **Options:** * `-r`, `--revision ` — The bookmark's target revision ## `jj bookmark delete` Delete an existing bookmark and propagate the deletion to remotes on the next push **Usage:** `jj bookmark delete ...` ###### **Arguments:** * `` — The bookmarks to delete By default, the specified name matches exactly. Use `glob:` prefix to select bookmarks by wildcard pattern. For details, see https://martinvonz.github.io/jj/latest/revsets/#string-patterns. ## `jj bookmark forget` Forget everything about a bookmark, including its local and remote targets A forgotten bookmark will not impact remotes on future pushes. It will be recreated on future pulls if it still exists in the remote. **Usage:** `jj bookmark forget ...` ###### **Arguments:** * `` — The bookmarks to forget By default, the specified name matches exactly. Use `glob:` prefix to select bookmarks by wildcard pattern. For details, see https://martinvonz.github.io/jj/latest/revsets/#string-patterns. ## `jj bookmark list` List bookmarks and their targets By default, a tracking remote bookmark will be included only if its target is different from the local target. A non-tracking remote bookmark won't be listed. For a conflicted bookmark (both local and remote), old target revisions are preceded by a "-" and new target revisions are preceded by a "+". For information about bookmarks, see https://martinvonz.github.io/jj/docs/bookmarks.md. **Usage:** `jj bookmark list [OPTIONS] [NAMES]...` ###### **Arguments:** * `` — Show bookmarks whose local name matches By default, the specified name matches exactly. Use `glob:` prefix to select bookmarks by wildcard pattern. For details, see https://martinvonz.github.io/jj/docs/revsets.md#string-patterns. ###### **Options:** * `-a`, `--all-remotes` — Show all tracking and non-tracking remote bookmarks including the ones whose targets are synchronized with the local bookmarks * `-t`, `--tracked` — Show remote tracked bookmarks only. Omits local Git-tracking bookmarks by default * `-c`, `--conflicted` — Show conflicted bookmarks only * `-r`, `--revisions ` — Show bookmarks whose local targets are in the given revisions Note that `-r deleted_bookmark` will not work since `deleted_bookmark` wouldn't have a local target. * `-T`, `--template