jj-describe(1)

💅 jj-describe(1) — General Commands Manual energy 💅

okay so this is the jj-describe(1) page, bestie, and we’re about to make editing change descriptions feel iconic ✨

---

🎀 NAME 🎀

• jj-describe — update the change description or other metadata [default alias: desc] 💖

---

✨ SYNOPSIS ✨

jj describe [-R|--repository] [--ignore-working-copy] [-m|--message]
[--no-integrate-operation] [--stdin] [--editor] [--ignore-immutable]
[--at-operation] [--debug] [--color] [--quiet] [--no-pager] [--config]
[--config-file] [-h|--help] [REVSETS]

---

🦋 DESCRIPTION 🦋

Update the change description or other metadata [default alias: desc]. That’s the whole vibe.

It starts an editor so you can edit the description of changes. Set ui.editor to customize your editor. For more info on how the editor gets chosen, check jj help -k config or the editor docs at https://docs.jj-vcs.dev/latest/config/#editor 🫶

---

🌸 OPTIONS 🌸

• -m, --message <MESSAGE> — the change description you want to use, and it does not open an editor. If you give multiple revisions, the same description gets used for all of them. slay 💅
• --stdin — read the change description from stdin. If you give multiple revisions, the same description gets used for all of them. fr fr.
• --editor — open an editor to edit the change description. This forces an editor open when you’re using --stdin or --message, so you can edit the message afterwards. obsessed.
• -h, --help — print help (see a summary with -h). cute.
• [REVSETS] — the revision(s) whose description you want to edit (default: @) [aliases: -r]. main character revision energy 👑

---

🌈 GLOBAL OPTIONS 🌈

• -R, --repository <REPOSITORY> — path to the repository to operate on. By default, Jujutsu searches for the closest .jj/ directory in an ancestor of the current working directory. lowkey handy.
• --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, 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. 💀
• --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. 🙈
• --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 <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. 🧚
• --debug — enable debug logging. nerdy and valid.
• --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. 🤫
• --no-pager — disable the pager. sometimes you just want the raw text, periodt.
• --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 a string value isn’t enclosed by any TOML constructs (such as array notation), quotes can be omitted. 💜
• --config-file <PATH> — additional configuration files (can be repeated). yes bestie, stack those config files 🌸

---

xoxo, your Unix bestie 💖 — this page’s footer source/version is describe + jj-describe(1), and there was no date printed, so I’m not making one up, periodt.