2023-09-06 18:24:24 +00:00
<!doctype html>
< html lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< link rel = "canonical" href = "https://martinvonz.github.io/jj/v0.9.0/install-and-setup.html" >
< link rel = "next" href = "tutorial.html" >
< link rel = "icon" href = "assets/images/favicon.png" >
< meta name = "generator" content = "mkdocs-1.5.2, mkdocs-material-9.2.5" >
< title > Installation and Setup - Jujutsu docs< / title >
< link rel = "stylesheet" href = "assets/stylesheets/main.0e669242.min.css" >
< script src = "https://unpkg.com/iframe-worker/shim" > < / script >
< link rel = "preconnect" href = "https://fonts.gstatic.com" crossorigin >
< link rel = "stylesheet" href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" >
< style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style >
< script > _ _md _scope = new URL ( "." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script >
< / head >
< body dir = "ltr" >
< script > var palette = _ _md _get ( "__palette" ) ; if ( palette && "object" == typeof palette . color ) for ( var key of Object . keys ( palette . color ) ) document . body . setAttribute ( "data-md-color-" + key , palette . color [ key ] ) < / script >
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" autocomplete = "off" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" autocomplete = "off" >
< label class = "md-overlay" for = "__drawer" > < / label >
< div data-md-component = "skip" >
< a href = "#installation-and-setup" class = "md-skip" >
Skip to content
< / a >
< / div >
< div data-md-component = "announce" >
< / div >
< div data-md-color-scheme = "default" data-md-component = "outdated" hidden >
< / div >
< header class = "md-header md-header--shadow" data-md-component = "header" >
< nav class = "md-header__inner md-grid" aria-label = "Header" >
< a href = "." title = "Jujutsu docs" class = "md-header__button md-logo" aria-label = "Jujutsu docs" data-md-component = "logo" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z" / > < / svg >
< / a >
< label class = "md-header__button md-icon" for = "__drawer" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z" / > < / svg >
< / label >
< div class = "md-header__title" data-md-component = "header-title" >
< div class = "md-header__ellipsis" >
< div class = "md-header__topic" >
< span class = "md-ellipsis" >
Jujutsu docs
< / span >
< / div >
< div class = "md-header__topic" data-md-component = "header-topic" >
< span class = "md-ellipsis" >
Installation and Setup
< / span >
< / div >
< / div >
< / div >
< label class = "md-header__button md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< / label >
< div class = "md-search" data-md-component = "search" role = "dialog" >
< label class = "md-search__overlay" for = "__search" > < / label >
< div class = "md-search__inner" role = "search" >
< form class = "md-search__form" name = "search" >
< input type = "text" class = "md-search__input" name = "query" aria-label = "Search" placeholder = "Search" autocapitalize = "off" autocorrect = "off" autocomplete = "off" spellcheck = "false" data-md-component = "search-query" required >
< label class = "md-search__icon md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" / > < / svg >
< / label >
< nav class = "md-search__options" aria-label = "Search" >
< button type = "reset" class = "md-search__icon md-icon" title = "Clear" aria-label = "Clear" tabindex = "-1" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z" / > < / svg >
< / button >
< / nav >
< / form >
< div class = "md-search__output" >
< div class = "md-search__scrollwrap" data-md-scrollfix >
< div class = "md-search-result" data-md-component = "search-result" >
< div class = "md-search-result__meta" >
Initializing search
< / div >
< ol class = "md-search-result__list" role = "presentation" > < / ol >
< / div >
< / div >
< / div >
< / div >
< / div >
< / nav >
< / header >
< div class = "md-container" data-md-component = "container" >
< main class = "md-main" data-md-component = "main" >
< div class = "md-main__inner md-grid" >
< div class = "md-sidebar md-sidebar--primary" data-md-component = "sidebar" data-md-type = "navigation" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--primary" aria-label = "Navigation" data-md-level = "0" >
< label class = "md-nav__title" for = "__drawer" >
< a href = "." title = "Jujutsu docs" class = "md-nav__button md-logo" aria-label = "Jujutsu docs" data-md-component = "logo" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z" / > < / svg >
< / a >
Jujutsu docs
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item md-nav__item--active md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_1" checked >
< label class = "md-nav__link" for = "__nav_1" id = "__nav_1_label" tabindex = "0" >
< span class = "md-ellipsis" >
Getting started
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_1_label" aria-expanded = "true" >
< label class = "md-nav__title" for = "__nav_1" >
< span class = "md-nav__icon md-icon" > < / span >
Getting started
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item md-nav__item--active" >
< input class = "md-nav__toggle md-toggle" type = "checkbox" id = "__toc" >
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
< span class = "md-ellipsis" >
Installation and Setup
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< a href = "install-and-setup.html" class = "md-nav__link md-nav__link--active" >
< span class = "md-ellipsis" >
Installation and Setup
< / span >
< / a >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#installation" class = "md-nav__link" >
Installation
< / a >
< nav class = "md-nav" aria-label = "Installation" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#linux" class = "md-nav__link" >
Linux
< / a >
< nav class = "md-nav" aria-label = "Linux" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#build-using-cargo" class = "md-nav__link" >
Build using cargo
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#nix-os" class = "md-nav__link" >
Nix OS
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#homebrew" class = "md-nav__link" >
Homebrew
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#mac" class = "md-nav__link" >
Mac
< / a >
< nav class = "md-nav" aria-label = "Mac" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#homebrew_1" class = "md-nav__link" >
Homebrew
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#macports" class = "md-nav__link" >
MacPorts
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#from-source" class = "md-nav__link" >
From Source
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#windows" class = "md-nav__link" >
Windows
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#initial-configuration" class = "md-nav__link" >
Initial configuration
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#command-line-completion" class = "md-nav__link" >
Command-line completion
< / a >
< nav class = "md-nav" aria-label = "Command-line completion" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#bash" class = "md-nav__link" >
Bash
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#zsh" class = "md-nav__link" >
Zsh
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#fish" class = "md-nav__link" >
Fish
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#xonsh" class = "md-nav__link" >
Xonsh
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "tutorial.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Tutorial and Birds-Eye View
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "github.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Working with GitHub
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "FAQ.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
FAQ
< / span >
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_3" >
< label class = "md-nav__link" for = "__nav_3" id = "__nav_3_label" tabindex = "0" >
< span class = "md-ellipsis" >
Concepts
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_3_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_3" >
< span class = "md-nav__icon md-icon" > < / span >
Concepts
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "working-copy.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Working Copy
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "branches.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Branches
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "conflicts.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Conflicts
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "operation-log.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Operation Log
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "glossary.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Glossary
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_4" >
< label class = "md-nav__link" for = "__nav_4" id = "__nav_4_label" tabindex = "0" >
< span class = "md-ellipsis" >
Configuration
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_4_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_4" >
< span class = "md-nav__icon md-icon" > < / span >
Configuration
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "config.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Settings
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "revsets.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Revset language
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "templates.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Templating language
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_5" >
< label class = "md-nav__link" for = "__nav_5" id = "__nav_5_label" tabindex = "0" >
< span class = "md-ellipsis" >
Comparisons
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_5_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_5" >
< span class = "md-nav__icon md-icon" > < / span >
Comparisons
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "git-comparison.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Git comparison
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "git-compatibility.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Git compatibility
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "sapling-comparison.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Sapling
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "related-work.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Other related work
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_6" >
< label class = "md-nav__link" for = "__nav_6" id = "__nav_6_label" tabindex = "0" >
< span class = "md-ellipsis" >
Technical details
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_6_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_6" >
< span class = "md-nav__icon md-icon" > < / span >
Technical details
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "technical/architecture.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Architecture
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "technical/concurrency.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Concurrency
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "technical/conflicts.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Conflicts
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_7" >
< label class = "md-nav__link" for = "__nav_7" id = "__nav_7_label" tabindex = "0" >
< span class = "md-ellipsis" >
Contributing
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_7_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_7" >
< span class = "md-nav__icon md-icon" > < / span >
Contributing
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "contributing.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Guidelines and "How to...?"
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "code-of-conduct.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Code of conduct
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_8" >
< label class = "md-nav__link" for = "__nav_8" id = "__nav_8_label" tabindex = "0" >
< span class = "md-ellipsis" >
Design docs
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_8_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_8" >
< span class = "md-nav__icon md-icon" > < / span >
Design docs
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "design/git-submodules.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
git-submodules
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "design/git-submodule-storage.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
git-submodule-storage
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "design/tracking-branches.html" class = "md-nav__link" >
< span class = "md-ellipsis" >
Tracking branches
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-sidebar md-sidebar--secondary" data-md-component = "sidebar" data-md-type = "toc" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#installation" class = "md-nav__link" >
Installation
< / a >
< nav class = "md-nav" aria-label = "Installation" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#linux" class = "md-nav__link" >
Linux
< / a >
< nav class = "md-nav" aria-label = "Linux" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#build-using-cargo" class = "md-nav__link" >
Build using cargo
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#nix-os" class = "md-nav__link" >
Nix OS
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#homebrew" class = "md-nav__link" >
Homebrew
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#mac" class = "md-nav__link" >
Mac
< / a >
< nav class = "md-nav" aria-label = "Mac" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#homebrew_1" class = "md-nav__link" >
Homebrew
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#macports" class = "md-nav__link" >
MacPorts
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#from-source" class = "md-nav__link" >
From Source
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#windows" class = "md-nav__link" >
Windows
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#initial-configuration" class = "md-nav__link" >
Initial configuration
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#command-line-completion" class = "md-nav__link" >
Command-line completion
< / a >
< nav class = "md-nav" aria-label = "Command-line completion" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#bash" class = "md-nav__link" >
Bash
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#zsh" class = "md-nav__link" >
Zsh
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#fish" class = "md-nav__link" >
Fish
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#xonsh" class = "md-nav__link" >
Xonsh
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
< h1 id = "installation-and-setup" > Installation and setup< a class = "headerlink" href = "#installation-and-setup" title = "Permanent link" > ¶ < / a > < / h1 >
< h2 id = "installation" > Installation< a class = "headerlink" href = "#installation" title = "Permanent link" > ¶ < / a > < / h2 >
< p > See below for how to build from source. There are also
< a href = "https://github.com/martinvonz/jj/releases" > pre-built binaries< / a > for Windows,
Mac, or Linux (musl).< / p >
< h3 id = "linux" > Linux< a class = "headerlink" href = "#linux" title = "Permanent link" > ¶ < / a > < / h3 >
< p > On most distributions, you'll need to build from source using < code > cargo< / code > directly.< / p >
< h4 id = "build-using-cargo" > Build using < code > cargo< / code > < a class = "headerlink" href = "#build-using-cargo" title = "Permanent link" > ¶ < / a > < / h4 >
< p > First make sure that you have the < code > libssl-dev< / code > , < code > openssl< / code > , and < code > pkg-config< / code >
packages installed by running something like this:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > sudo< span class = "w" > < / span > apt-get< span class = "w" > < / span > install< span class = "w" > < / span > libssl-dev< span class = "w" > < / span > openssl< span class = "w" > < / span > pkg-config
< / code > < / pre > < / div >
< p > Now run:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > cargo< span class = "w" > < / span > install< span class = "w" > < / span > --git< span class = "w" > < / span > https://github.com/martinvonz/jj.git< span class = "w" > < / span > --locked< span class = "w" > < / span > --bin< span class = "w" > < / span > jj< span class = "w" > < / span > jj-cli
< / code > < / pre > < / div >
< h4 id = "nix-os" > Nix OS< a class = "headerlink" href = "#nix-os" title = "Permanent link" > ¶ < / a > < / h4 >
< p > If you're on Nix OS you can use the flake for this repository.
For example, if you want to run < code > jj< / code > loaded from the flake, use:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > nix< span class = "w" > < / span > run< span class = "w" > < / span > < span class = "s1" > ' github:martinvonz/jj' < / span >
< / code > < / pre > < / div >
< p > You can also add this flake url to your system input flakes. Or you can
install the flake to your user profile:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > nix< span class = "w" > < / span > profile< span class = "w" > < / span > install< span class = "w" > < / span > < span class = "s1" > ' github:martinvonz/jj' < / span >
< / code > < / pre > < / div >
< h4 id = "homebrew" > Homebrew< a class = "headerlink" href = "#homebrew" title = "Permanent link" > ¶ < / a > < / h4 >
< p > If you use linuxbrew, you can run:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > brew< span class = "w" > < / span > install< span class = "w" > < / span > jj
< / code > < / pre > < / div >
< h3 id = "mac" > Mac< a class = "headerlink" href = "#mac" title = "Permanent link" > ¶ < / a > < / h3 >
< h4 id = "homebrew_1" > Homebrew< a class = "headerlink" href = "#homebrew_1" title = "Permanent link" > ¶ < / a > < / h4 >
< p > If you use Homebrew, you can run:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > brew< span class = "w" > < / span > install< span class = "w" > < / span > jj
< / code > < / pre > < / div >
< h4 id = "macports" > MacPorts< a class = "headerlink" href = "#macports" title = "Permanent link" > ¶ < / a > < / h4 >
< p > You can also install < code > jj< / code > via < a href = "https://www.macports.org" > MacPorts< / a > (as
the < code > jujutsu< / code > port):< / p >
< div class = "highlight" > < pre > < span > < / span > < code > sudo< span class = "w" > < / span > port< span class = "w" > < / span > install< span class = "w" > < / span > jujutsu
< / code > < / pre > < / div >
< p > (< a href = "https://ports.macports.org/port/jujutsu/" > port page< / a > )< / p >
< h4 id = "from-source" > From Source< a class = "headerlink" href = "#from-source" title = "Permanent link" > ¶ < / a > < / h4 >
< p > You may need to run some or all of these:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > xcode-select< span class = "w" > < / span > --install
brew< span class = "w" > < / span > install< span class = "w" > < / span > openssl
brew< span class = "w" > < / span > install< span class = "w" > < / span > pkg-config
< span class = "nb" > export< / span > < span class = "w" > < / span > < span class = "nv" > PKG_CONFIG_PATH< / span > < span class = "o" > =< / span > < span class = "s2" > " < / span > < span class = "k" > $(< / span > brew< span class = "w" > < / span > --prefix< span class = "k" > )< / span > < span class = "s2" > /opt/openssl@3/lib/pkgconfig" < / span >
< / code > < / pre > < / div >
< p > Now run:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > cargo< span class = "w" > < / span > install< span class = "w" > < / span > --git< span class = "w" > < / span > https://github.com/martinvonz/jj.git< span class = "w" > < / span > --locked< span class = "w" > < / span > --bin< span class = "w" > < / span > jj< span class = "w" > < / span > jj-cli
< / code > < / pre > < / div >
< h3 id = "windows" > Windows< a class = "headerlink" href = "#windows" title = "Permanent link" > ¶ < / a > < / h3 >
< p > Run:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > cargo< span class = "w" > < / span > install< span class = "w" > < / span > --git< span class = "w" > < / span > https://github.com/martinvonz/jj.git< span class = "w" > < / span > --locked< span class = "w" > < / span > --bin< span class = "w" > < / span > jj< span class = "w" > < / span > jj-cli< span class = "w" > < / span > --features< span class = "w" > < / span > vendored-openssl
< / code > < / pre > < / div >
< h2 id = "initial-configuration" > Initial configuration< a class = "headerlink" href = "#initial-configuration" title = "Permanent link" > ¶ < / a > < / h2 >
< p > You may want to configure your name and email so commits are made in your name.< / p >
< div class = "highlight" > < pre > < span > < / span > < code > $< span class = "w" > < / span > jj< span class = "w" > < / span > config< span class = "w" > < / span > < span class = "nb" > set< / span > < span class = "w" > < / span > --user< span class = "w" > < / span > user.name< span class = "w" > < / span > < span class = "s2" > " Martin von Zweigbergk" < / span >
$< span class = "w" > < / span > jj< span class = "w" > < / span > config< span class = "w" > < / span > < span class = "nb" > set< / span > < span class = "w" > < / span > --user< span class = "w" > < / span > user.email< span class = "w" > < / span > < span class = "s2" > " martinvonz@google.com" < / span >
< / code > < / pre > < / div >
< h2 id = "command-line-completion" > Command-line completion< a class = "headerlink" href = "#command-line-completion" title = "Permanent link" > ¶ < / a > < / h2 >
< p > To set up command-line completion, source the output of
2023-09-08 01:12:11 +00:00
< code > jj util completion --bash/--zsh/--fish< / code > . Exactly how to source it
depends on your shell.< / p >
2023-09-06 18:24:24 +00:00
< h3 id = "bash" > Bash< a class = "headerlink" href = "#bash" title = "Permanent link" > ¶ < / a > < / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "nb" > source< / span > < span class = "w" > < / span > < < span class = "o" > (< / span > jj< span class = "w" > < / span > util< span class = "w" > < / span > completion< span class = "o" > )< / span > < span class = "w" > < / span > < span class = "c1" > # --bash is the default< / span >
< / code > < / pre > < / div >
< h3 id = "zsh" > Zsh< a class = "headerlink" href = "#zsh" title = "Permanent link" > ¶ < / a > < / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > autoload< span class = "w" > < / span > -U< span class = "w" > < / span > compinit
compinit
< span class = "nb" > source< / span > < span class = "w" > < / span > < < span class = "o" > (< / span > jj< span class = "w" > < / span > util< span class = "w" > < / span > completion< span class = "w" > < / span > --zsh< span class = "o" > )< / span >
< / code > < / pre > < / div >
< h3 id = "fish" > Fish< a class = "headerlink" href = "#fish" title = "Permanent link" > ¶ < / a > < / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > jj< span class = "w" > < / span > util< span class = "w" > < / span > completion< span class = "w" > < / span > --fish< span class = "w" > < / span > < span class = "p" > |< / span > < span class = "w" > < / span > < span class = "nb" > source< / span >
< / code > < / pre > < / div >
< h3 id = "xonsh" > Xonsh< a class = "headerlink" href = "#xonsh" title = "Permanent link" > ¶ < / a > < / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > source-bash< span class = "w" > < / span > < span class = "k" > $(< / span > jj< span class = "w" > < / span > util< span class = "w" > < / span > completion< span class = "k" > )< / span >
< / code > < / pre > < / div >
< / article >
< / div >
< / div >
< / main >
< footer class = "md-footer" >
< div class = "md-footer-meta md-typeset" >
< div class = "md-footer-meta__inner md-grid" >
< div class = "md-copyright" >
Made with
< a href = "https://squidfunk.github.io/mkdocs-material/" target = "_blank" rel = "noopener" >
Material for MkDocs
< / a >
< / div >
< / div >
< / div >
< / footer >
< / div >
< div class = "md-dialog" data-md-component = "dialog" >
< div class = "md-dialog__inner md-typeset" > < / div >
< / div >
< script id = "__config" type = "application/json" > { "base" : "." , "features" : [ ] , "search" : "assets/javascripts/workers/search.dfff1995.min.js" , "translations" : { "clipboard.copied" : "Copied to clipboard" , "clipboard.copy" : "Copy to clipboard" , "search.result.more.one" : "1 more on this page" , "search.result.more.other" : "# more on this page" , "search.result.none" : "No matching documents" , "search.result.one" : "1 matching document" , "search.result.other" : "# matching documents" , "search.result.placeholder" : "Type to start searching" , "search.result.term.missing" : "Missing" , "select.version" : "Select version" } , "version" : { "provider" : "mike" } } < / script >
< script src = "assets/javascripts/bundle.78eede0e.min.js" > < / script >
< / body >
< / html >
