jj-workspace(1)

📦
version 0.46.0 · 2 versions
, in arch rolling, nixpkgs unstable

🌟 jj-workspace(1) 🌟

Okay bestie, buckle up because this is the manual page for jj-workspace from the General Commands Manual, and it's literally all about making workspaces work for you. 💅

✨ NAME ✨

jj-workspace — Commands for working with workspaces. That's it. That's the vibe. 🎀

🌸 SYNOPSIS 🌸

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

Like, obviously you're passing subcommands in there. No cap. 🫶

💖 DESCRIPTION 💖

Commands for working with workspaces. Simple enough, right? But wait, there's more.

Workspaces let you add additional working copies attached to the same repo. The classic glow-up move? Run a slow build or test in one workspace while you keep writing code in another workspace. Multitasking queen behavior, honestly. 👑

Every workspace gets its own working-copy commit. When you've got more than one workspace attached to a repo, they show up as <workspace name>@ in jj log. So you can tell them apart at a glance. 🕵️‍♀️

And yes, each workspace also has its own sparse patterns. Sparse is the vibe. ✨

💅 OPTIONS 💅

  • -h, --help — Prints help, bestie. (See a summary with -h.) 💁‍♀️

🌈 GLOBAL OPTIONS 🌈

Okay so these are the big-picture options that apply all over the place. Let's get into it.

  • -R, --repository <REPOSITORY> — Path to the repository you're operating on. By default, Jujutsu searches for the closest .jj/ directory in an ancestor of the current working directory. It's giving "find my repo" energy. 🔍
  • --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. Just so you know. 💡
  • --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, don't get it twisted. 🚨
  • --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 don't think it's changing those, bestie. 🙅‍♀️

  • --at-operation <AT_OPERATION> — 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. So like, proceed with caution but also live your truth. 😌

  • --debug — Enable debug logging. For when you need to see everything. 🐛
  • --color <WHEN> — When to colorize output. Possible values:
    • always
    • never
    • debug
    • auto

Pick your fighter. 🎨

  • --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 you're not totally in the dark. 👀

  • --no-pager — Disable the pager. For when you just want the output right there, no scrolling drama. 📜
  • --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. TOML queen behavior. 💃
  • --config-file <PATH> — Additional configuration files (can be repeated). Stack 'em up. 📂

🦋 SUBCOMMANDS 🦋

These are the actual moves you can pull. Each one has its own manual page, so go off.

That's the tea, bestie. This page is from the General Commands Manual of Jujutsu, and it's your girl jj-workspace(1) signing off from the workspace section. No date, just vibes. Stay slay, and may your workspaces always be fresh. 💖✨🦋

P.S. This is jj-workspace(1) from the workspace section of the manual. Periodt. 🎀
📦 where this page comes from