jj-util-markdown-help(1)

πŸ‘‘ jj-util-markdown-help β€” the manpage, but make it cute

okay bestie, you're looking at jj-util-markdown-help from the General Commands Manual (that's the manual we're in, jj-util-markdown-help(1), hi hello it's me πŸ’–).


✨ NAME ✨

jj-util-markdown-help β€” print the CLI help for all subcommands in Markdown πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

jj util markdown-help [-R|--repository] [--ignore-working-copy]
[--no-integrate-operation] [--ignore-immutable] [--at-operation]
[--debug] [--color] [--quiet] [--no-pager] [--config] [--config-file]
[-h|--help]

that's the whole vibe check right there. yes, it's a lot of brackets. no, you don't need all of them. 🫢


🌸 DESCRIPTION 🌸

Print the CLI help for all subcommands in Markdown. that's it. that's the job. it's giving documentation-generator realness and honestly? iconic. ✨


πŸ’… OPTIONS πŸ’…

  • -h, --help β€” print help (and if you want the short version, hit it with just -h for a summary)

🌈 GLOBAL OPTIONS 🌈

these ones work basically everywhere, so they get their own little section. slay.

  • -R, --repository <REPOSITORY> β€” the path to the repository you wanna operate on πŸ—‚οΈ

by default, Jujutsu goes hunting for the closest .jj/ directory in an ancestor of your current working directory. it's like a little treasure hunt but it always finds the repo (iykyk).

  • --ignore-working-copy β€” don't snapshot the working copy, and don't update it πŸ™ˆ

so here's the deal: by default Jujutsu snapshots the working copy at the very beginning of every single command. it also updates it at the end of the command if the command modified the working-copy commit (@). but if you'd rather ✨not✨ snapshot and instead look at a possibly stale working-copy commit, this flag is your girl. it's lowkey useful in a command prompt, especially if you've got another process off somewhere committing the working copy.

heads up: loading the repository at a specific operation with --at-operation implies --ignore-working-copy. they're a package deal, no cap.
  • --no-integrate-operation β€” run the command as usual but don't integrate any operations πŸŒ€

give this one and the operations still get created like normal, they just don't get integrated into the operation log. also, the working copy will not be updated. periodt.

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. so many options bestie πŸ’…

note that this does not prevent side effects outside the repo. for example, jj git push --no-integrate-operation will still perform the push. yeah. it said what it said. πŸ’€
  • --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. main character energy, but the root commit stays untouched, sorry.

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 βͺ

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 β€” no need to type the whole thing, we're not monsters. 🫢

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. (it's giving chaos goblin, and honestly, we respect it. but rarely.)

  • --debug β€” enable debug logging πŸ›
  • --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. it's the "less yapping please" flag.

warnings and errors will still be printed. safety first, always. πŸ’–

  • --no-pager β€” disable the pager πŸ“„
  • --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. fancy but chill.

  • --config-file <PATH> β€” additional configuration files (can be repeated) πŸ“

okay that's the whole page, you ate it fr fr. πŸ“

this little cutie lives under the name markdown-help in the jj-util-markdown-help(1) manual, so if you ever need to find it again, that's where she's at. mwah, bye bestie πŸ’œβœ¨

πŸ“¦ where this page comes from