jj-workspace-rename(1)

πŸ’– jj-workspace-rename β€” the manual page, but make it make sense

okay bestie, so this page is jj-workspace-rename(1) from the General Commands Manual, and it lives in section 1 (that's the "user commands, run these in your shell" section, iykyk). It's a whole single page, one command, and honestly? Iconic behaviour. Let's get into it. πŸŽ€


✨ NAME ✨

jj-workspace-rename β€” renames the current workspace. That's it. That's the whole job. She's a one-trick pony and she ate. πŸ’…


🌸 SYNOPSIS 🌸

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

yeah it's a lot of brackets, don't panic. They're all optional except the name at the end. Everything in [ ] is "only if you want, bestie" and the <NEW_WORKSPACE_NAME> is the girl you actually have to show up with. πŸ¦‹


πŸ’œ DESCRIPTION πŸ’œ

Renames the current workspace.

That's literally the whole description and honestly? Respect the brevity. No notes. 🌈


✨ OPTIONS ✨

  • -h, --help β€” prints the help text. note that this one gives you the full help, and if you want the little short summary version you pass -h instead. lowkey handy when you just need a snack-sized reminder. πŸ“
  • <NEW_WORKSPACE_NAME> β€” the name of the workspace to update to. so like, the fresh new name you want your workspace to be wearing from now on. main character rebrand energy. πŸ‘‘

🌟 GLOBAL OPTIONS 🌟

these are the options that travel with you across basically every jj command, so learn them once and you're set for life. fr fr.

  • -R, --repository <REPOSITORY> β€” path to the repository you want to operate on. By default, Jujutsu searches for the closest .jj/ directory in an ancestor of the current working directory. so if you're chilling inside your repo somewhere, it'll sniff out the .jj/ all on its own. no cap. 🐾
  • --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. Also, loading the repository at a specific operation with --at-operation implies --ignore-working-copy, so that one sneaks it in for you whether you asked or not. πŸ’€
  • --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 like, the repo side stays un-integrated but the outside world already got the tea. 😭
  • --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. so it's just loosening the seatbelt, not rewriting the rules of the road. πŸš—πŸ’¨
  • --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. for when you need the full behind-the-scenes commentary track. πŸ”
  • --color <WHEN> β€” when to colorize output. Possible values:
    • always
    • never
    • debug
    • auto

pick your aesthetic, bestie. 🌈

  • --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, so don't worry, you won't miss anything important. she just stops the small talk. 🀫
  • --no-pager β€” disable the pager. output goes straight to your terminal instead of getting handed off to whatever pager you've got. πŸ“„
  • --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 she takes repeats, stack 'em up. 🧚
  • --config-file <PATH> β€” additional configuration files (can be repeated). same deal, more than one is totally fine. πŸ’–

and that's the whole page, bestie!! 🫢 this cutie came from the rename source, and the page is dated/versioned alongside jj-workspace-rename(1) β€” so when you're looking at the footer, that's the origin story right there. go rename your workspace, you gorgeous genius. πŸ’…βœ¨πŸŒΈ

πŸ“¦ where this page comes from