jj-sign(1)

💖 jj-sign(1) — the manual page, but make it slay ✨

okay bestie, pull up a chair because today we're talking about jj-sign, aka the jj sign command, aka the glow-up your commits deserve. it's a General Commands Manual situation and honestly? iconic.

---

🌸 NAME 🌸

jj-sign — cryptographically sign a revision 💅

like, you know how you sign a letter? this but for your commit, and with cryptography, and with infinitely more swagger.

---

🎀 SYNOPSIS 🎀

jj sign [-r|--revision] [-R|--repository] [--ignore-working-copy]
[--key] [--no-integrate-operation] [--ignore-immutable] [--at-operation]
[--debug] [--color] [--quiet] [--no-pager] [--config] [--config-file]
[-h|--help]

---

✨ DESCRIPTION ✨

Cryptographically sign a revision. that's the whole job. that's the assignment. she ate 💅

⚠️ real talk for a second: this command requires configuring a [commit signing] backend. no backend, no signing. it's giving "you can't sit with us unless you set up your config first".

[commit signing]: https://docs.jj-vcs.dev/latest/config/#commit-signing

---

🔥 OPTIONS 🔥

• -r, --revision <REVSETS> — what revision(s) to sign. yep, plural, she can handle more than one, main character energy fr fr.

if you don't specify any revisions, it defaults to the revsets.sign setting. so set that up if you're tired of typing, iykyk.

also, heads up: revisions are always re-signed. like, every single time. no shortcuts.

and okay, bestie, this part is kind of a vibe killer: while that leads to discomfort for users, which sign with hardware devices, as of now we cannot reliably check if a commit is already signed by the user without creating a signature (see [#5786]). the way that we literally cannot check without doing the thing we're checking for?? 😭 that's the situation, we're living in it.

[#5786]: https://github.com/jj-vcs/jj/issues/5786

• --key <KEY> — the key used for signing. your key, your signature, your moment 🔑
• -h, --help — print help (see a summary with -h). the classic. never not useful.

---

🌈 GLOBAL OPTIONS 🌈

these apply all over the place, not just here. still gotta know them though, no skipping.

• -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. she's a finder. she finds. 🧚

• --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. so it's kind of a package deal 💀

• --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. look at her being all modular 🫶

note that this does not prevent side effects outside the repo. for example, jj git push --no-integrate-operation will still perform the push. so like, don't be surprised. 🙈

• --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. root stays untouched, that's just the law.

this option only affects the check. it does not affect the immutable_heads() revset or the immutable template keyword. so the check is off, but those two are doing their own thing entirely.

• --at-operation <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=<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. short queen, minimal effort, same result 💅

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. so like... you can. whether you should is between you and your repo. 😭

• --debug — enable debug logging. for when you need the tea and the logs both.
• --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. so she's still doing the work, just not narrating it.

warnings and errors will still be printed. silence is selective, bestie.

• --no-pager — disable the pager. straight to your terminal, no middleman.
• --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. yes you read that right, you can skip the quotes sometimes. treat yourself. ✨

• --config-file <PATH> — additional configuration files (can be repeated). bring your own config, she's flexible like that.

---

and that's the whole page, bestie! 🌸 this one came straight from the sign source, versioned under the jj-sign(1) manual — so if you ever need to cite your sources, that's the citation. go sign something gorgeous. periodt. 💖✨🦋