jj-help(1)

πŸ’– jj-help(1) πŸ’–

okay bestie, welcome to the jj-help manual page β€” the ✨General Commands Manual✨ entry, no less. this is your group chat with the jj CLI itself. let's get into it 🫢


✨ NAME ✨

jj-help β€” print this message or the help of the given subcommand(s) πŸ’…


🌸 SYNOPSIS 🌸

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

πŸ¦‹ DESCRIPTION πŸ¦‹

Print this message or the help of the given subcommand(s). that's it, that's the whole vibe. it's the "hey, explain yourself" button πŸ’–


πŸŽ€ OPTIONS πŸŽ€

  • -k, --keyword <KEYWORD> β€” show help for keywords instead of commands πŸ‘‘

the possible values, bestie, are:

  • bookmarks: named pointers to revisions (basically Git's branches, iykyk)
  • config: how and where to set configuration options
  • filesets: a functional language for selecting a set of files
  • glossary: definitions of various terms
  • revsets: a functional language for selecting a set of revision
  • templates: a functional language to customize command output
  • tutorial: show a tutorial to get started with jj
  • -h, --help β€” print help (see a summary with -h) πŸ™ˆ
  • [COMMAND] β€” print help for the subcommand(s) ⭐

🌈 GLOBAL OPTIONS 🌈

these ones live everywhere, they're the main characters of the whole CLI πŸ’œ

  • -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 goes looking up the family tree, periodt.

  • --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. no cap, it just does.

  • --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 push is gonna push, bestie.
  • --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. it's just the bouncer stepping aside, not the whole guest list changing.

  • --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. slay, prefixes count.

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. like, it's giving chaos but it IS allowed πŸ’€

  • --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.

warnings and errors will still be printed. those ones never shut up, and honestly? valid.

  • --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 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) πŸ“š

and that's the whole page, babe 🌸 the footer of this lil beauty reads help on the left and jj-help(1) on the right β€” so yeah, source "help", version-of-record jj-help(1), and you already know the date is whatever today feels like 😌✨ you ate, go read some revsets now πŸ’…πŸ‘‘

πŸ“¦ where this page comes from