jk manual
Coverage map
Trace each implemented form from its manual chapter to recorded scenarios, repository checks, and UX findings.
The inventory is checked against jk's command builders, CLI arguments, and interaction routes. Native support, explicit command-mode alternatives, and unavailable forms are separate. Each recording includes checks of the resulting repository.
109 command, option, and interaction entries · 48 scenarios · 48 permanent recordings.
Command mode forwards explicit jj commands. Illustrative forwarded forms without a scenario link have not been exercised by this collection; the manual does not claim full jj CLI coverage.
| Form | Support and guide | Scenarios | Findings |
|---|---|---|---|
Choose the repositoryjj --repository PATH ... | Native start | No finding linked | |
Open a local repository containerjj root; jj workspace list | Native start | ||
Choose dialog appearancejk --dialog-theme auto|dark|light | Native start | No finding linked | |
Open the configured viewjj | Native inspect | No finding linked | |
Open the explicit logjj log | Native inspect | No finding linked | |
Limit visible historyjj [log] -n LIMIT | Native inspect | No finding linked | |
Use the configured log templatejj log | Native inspect | No finding linked | |
Use the comfortable log templatejj log -T builtin_log_comfortable | Native inspect | No finding linked | |
Use the compact log templatejj log -T builtin_log_compact | Native inspect | No finding linked | |
Use the full-description log templatejj log -T builtin_log_compact_full_description | Native inspect | No finding linked | |
Use the detailed log templatejj log -T builtin_log_detailed | Native inspect | No finding linked | |
Use the oneline log templatejj log -T builtin_log_oneline | Native inspect | No finding linked | |
Use the redacted log templatejj log -T builtin_log_redacted | Native inspect | No finding linked | |
Use the custom log templatejj log -T TEMPLATE | Native inspect | No finding linked | |
Open hidden graph historyjj log -r ELISION_REVSET | Native inspect | No finding linked | |
Inspect a revision (patch)jj diff -r REV | Native inspect | ||
Inspect a revision (summary)jj diff -r REV --summary | Native inspect | ||
Inspect a revision (stat)jj diff -r REV --stat | Native inspect | ||
Inspect a revision (types)jj diff -r REV --types | Native inspect | ||
Inspect a revision (name-only)jj diff -r REV --name-only | Native inspect | ||
Inspect a revision (git)jj diff -r REV --git | Native inspect | ||
Inspect a revision (color-words)jj diff -r REV --color-words | Native inspect | ||
Compare two revisions (patch)jj diff --from FROM --to TO | Native inspect | ||
Compare two revisions (summary)jj diff --from FROM --to TO --summary | Native inspect | ||
Compare two revisions (stat)jj diff --from FROM --to TO --stat | Native inspect | ||
Compare two revisions (types)jj diff --from FROM --to TO --types | Native inspect | ||
Compare two revisions (name-only)jj diff --from FROM --to TO --name-only | Native inspect | ||
Compare two revisions (git)jj diff --from FROM --to TO --git | Native inspect | ||
Compare two revisions (color-words)jj diff --from FROM --to TO --color-words | Native inspect | ||
Navigate diff text and parsed filesjj diff (rendered view) | Native inspect | ||
Inspect one changejj show REV | Native inspect | ||
Inspect several revisionsjj show REV... | Native inspect | ||
Inspect working-copy statusjj status | Native inspect | ||
Limit status to filesetsjj status FILESET... | Native inspect | ||
Inspect change evolutionjj evolog -r REV | Native inspect | ||
Start a child changejj new PARENT | Native shape changes | No finding linked | |
Create a merge changejj new PARENT... | Native shape changes | ||
Resume an existing changejj edit REV | Native shape changes | No finding linked | |
Write a descriptionjj describe -m MESSAGE REV | Native shape changes | ||
Abandon an empty changejj abandon REV | Native shape changes | No finding linked | |
Review and abandon a changejj abandon REV | Native shape changes | ||
Review an uncertain abandonjj abandon REV | Native shape changes | ||
Move one change onto a new parentjj rebase -r SOURCE -o DESTINATION | Native rebase | ||
Insert one change after a destinationjj rebase -r SOURCE -A DESTINATION | Native rebase | ||
Insert one change before a destinationjj rebase -r SOURCE -B DESTINATION | Native rebase | ||
Move a change and its descendants onto a new parentjj rebase -s SOURCE -o DESTINATION | Native rebase | ||
Insert a change and its descendants after a destinationjj rebase -s SOURCE -A DESTINATION | Native rebase | ||
Insert a change and its descendants before a destinationjj rebase -s SOURCE -B DESTINATION | Native rebase | ||
Move a branch onto a new parentjj rebase -b SOURCE -o DESTINATION | Native rebase | ||
Insert a branch after a destinationjj rebase -b SOURCE -A DESTINATION | Native rebase | ||
Insert a branch before a destinationjj rebase -b SOURCE -B DESTINATION | Native rebase | ||
Combine a source changejj squash --from SOURCE --into DESTINATION --use-destination-message | Native shape changes | ||
Combine several source changesjj squash --from SOURCE --from SOURCE... --into DESTINATION --use-destination-message | Native shape changes | ||
Restore all paths into the working copyjj restore --from SOURCE --into @ | Native shape changes | ||
Inspect bookmarksjj bookmark list --all-remotes | Native bookmarks remotes | ||
Create a bookmarkjj bookmark create --revision REV -- NAME | Native bookmarks remotes | ||
Move a bookmarkjj bookmark move --to REV -- exact:NAME | Native bookmarks remotes | ||
Delete a local bookmarkjj bookmark delete -- exact:NAME | Native bookmarks remotes | ||
Choose a remotejj git remote list | Native bookmarks remotes | No finding linked | |
Fetch an explicit remotejj git fetch --remote exact:REMOTE | Native bookmarks remotes | ||
Preview publishing one bookmarkjj git push --remote REMOTE --bookmark exact:NAME --dry-run | Native bookmarks remotes | ||
List workspacesjj workspace list | Native workspaces | No finding linked | |
Inspect another workspace statusjj -R ROOT status | Native workspaces | ||
Inspect another workspace historyjj -R ROOT log | Native workspaces | ||
Inspect another workspace diffjj -R ROOT diff | Native workspaces | ||
Add a workspacejj workspace add PATH --name BASENAME | Native workspaces | ||
Rename workspace metadatajj -R ROOT workspace rename NAME | Native workspaces | ||
Forget workspace metadatajj workspace forget NAME | Native workspaces | ||
Update a stale workspacejj -R ROOT workspace update-stale | Native workspaces | ||
Inspect repository operationsjj op log | Native recovery | ||
Inspect one operationjj op show OPERATION | Native recovery | ||
Compare an operation with its parentjj op diff --operation OPERATION | Native recovery | ||
Undo the latest operationjj undo | Native recovery | No finding linked | |
Redo the latest operationjj redo | Native recovery | No finding linked | |
Inspect executed commandsjk session command history | Native recovery | ||
Ignore working-copy filesjj --ignore-working-copy COMMAND | Native run options | ||
Run at a historical operationjj --at-operation OPERATION COMMAND | Native run options | ||
Allow immutable rewritesjj --ignore-immutable COMMAND | Native run options | ||
Run a captured jj commandjj ARGS... | Native command mode | ||
Run a captured executableEXECUTABLE ARGS... | Native command mode | ||
Supersede a slow log refreshjj log (background refresh) | Native inspect | No finding linked | |
Commit the working copyjj commit -m MESSAGE | Command mode shape changes | ||
Copy a revisionjj duplicate REV | Command mode shape changes | No finding linked | |
Apply inverse changesjj revert -r REV -o DESTINATION | Command mode shape changes | No finding linked | |
Absorb working-copy editsjj absorb | Command mode shape changes | No finding linked | |
Compare change versionsjj interdiff --from FROM --to TO | Command mode inspect | No finding linked | |
Run an arbitrary revset queryjj log -r REVSET | Command mode inspect | No finding linked | |
Split by named pathsjj split FILESET... -m MESSAGE | Command mode shape changes | ||
Restore selected pathsjj restore --from SOURCE FILESET... | Command mode shape changes | ||
Restore changes made in a revisionjj restore --changes-in REV FILESET... | Command mode shape changes | Forwarded example; no exact-form recording | |
Squash selected pathsjj squash --from SOURCE --into DESTINATION FILESET... --use-destination-message | Command mode shape changes | Forwarded example; no exact-form recording | |
Abandon several revisionsjj abandon REV... | Command mode shape changes | Forwarded example; no exact-form recording | No finding linked |
Create with advanced optionsjj new -m MESSAGE PARENT... | Command mode shape changes | Forwarded example; no exact-form recording | No finding linked |
Rebase several source revisionsjj rebase -r SOURCE -r SOURCE -o DESTINATION | Command mode rebase | Forwarded example; no exact-form recording | |
Track a remote bookmarkjj bookmark track exact:NAME --remote exact:REMOTE | Command mode bookmarks remotes | No finding linked | |
Stop tracking a remote bookmarkjj bookmark untrack exact:NAME --remote exact:REMOTE | Command mode bookmarks remotes | No finding linked | |
Rename a local bookmarkjj bookmark rename OLD NEW | Command mode bookmarks remotes | No finding linked | |
Forget local bookmark metadatajj bookmark forget NAME | Command mode bookmarks remotes | No finding linked | |
Create a workspace with explicit parentsjj workspace add PATH --name NAME -r REV | Command mode workspaces | Forwarded example; no exact-form recording | No finding linked |
Restore an earlier operationjj op restore OPERATION | Command mode recovery | Forwarded example; no exact-form recording | No finding linked |
Integrate an operationjj op integrate OPERATION | Command mode recovery | Forwarded example; no exact-form recording | No finding linked |
Use an external description editorjj describe REV | Outside jk shape changes | Outside the native workflow | |
Split interactivelyjj split -i | Outside jk shape changes | Outside the native workflow | |
Edit a diff with a tooljj diffedit | Outside jk shape changes | Outside the native workflow | |
Resolve using a merge tooljj resolve | Outside jk shape changes | Outside the native workflow | |
Publish changesjj git push | Outside jk bookmarks remotes | Outside the native workflow | |
Mutate selected hunksjj squash/restore/commit/split -i | Outside jk shape changes | Outside the native workflow | |
Restore at a historical operationjj --at-operation OPERATION restore --from SOURCE --into DESTINATION | Command mode run options | Forwarded example; no exact-form recording | |
Run without integrating an operationjj --no-integrate-operation COMMAND | Command mode run options | Forwarded example; no exact-form recording | No finding linked |