jj-util-completion(1)

πŸ’– jj-util-completion β€” bestie edition πŸ’–

okay so this is jj-util-completion(1), from the General Commands Manual section (section 1, the "you can literally just run this" section, we love her). Sit down, grab a strawberry πŸ“, and let's get you a completion script.


✨ NAME ✨

jj-util-completion β€” print a command-line-completion script πŸŽ€

✨ SYNOPSIS ✨

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

✨ DESCRIPTION ✨

Print a command-line-completion script, bestie. That's it. That's the whole job. πŸ’…

Apply it by running one of these:

  • Bash: source <(jj util completion bash)
  • Fish: jj util completion fish | source
  • Nushell:
jj util completion nushell | save -f "completions-jj.nu"
use "completions-jj.nu" *  # Or `source "completions-jj.nu"`
  • Zsh:
autoload -U compinit
compinit
source <(jj util completion zsh)

See the docs on [command-line completion] for more details.

[command-line completion]: https://docs.jj-vcs.dev/latest/install-and-setup/#command-line-completion

iykyk β€” tab-completion is the single biggest glow-up your terminal will ever have. 🌈


✨ OPTIONS ✨

  • -h, --help β€” print help (see a summary with '-h') 🫢
  • <SHELL> β€” the shell whose completion script you want, queen πŸ‘‘

Possible values:

  • bash
  • elvish
  • fish
  • nushell
  • power-shell
  • zsh

πŸ‘‘ GLOBAL OPTIONS πŸ‘‘

these hit different β€” they work on basically every jj command, not just this one.

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

  • --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-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. 😭 so be careful, fr fr.
  • --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 βͺ

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 πŸ”
  • --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 πŸ“„
  • --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, bestie!! you're officially a completion-script-having person now, main character energy honestly πŸ¦‹βœ¨

this was completion from jj-util-completion(1) β€” slay, periodt πŸ’…πŸ’–

πŸ“¦ where this page comes from