man1/scalar.1

   1 '\" t
   2 .\"     Title: scalar
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2024-02-02
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.43.0.522.g2a540e432f
   8 .\"  Language: English
   9 .\"
  10 .TH "SCALAR" "1" "2024\-02\-02" "Git 2\&.43\&.0\&.522\&.g2a540e" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 scalar \- A tool for managing large Git repositories
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 scalar clone [\-\-single\-branch] [\-\-branch <main\-branch>] [\-\-full\-clone]
  36         [\-\-[no\-]src] <url> [<enlistment>]
  37 scalar list
  38 scalar register [<enlistment>]
  39 scalar unregister [<enlistment>]
  40 scalar run ( all | config | commit\-graph | fetch | loose\-objects | pack\-files ) [<enlistment>]
  41 scalar reconfigure [ \-\-all | <enlistment> ]
  42 scalar diagnose [<enlistment>]
  43 scalar delete <enlistment>
  44 .fi
  45 .sp
  46 .SH "DESCRIPTION"
  47 .sp
  48 Scalar is a repository management tool that optimizes Git for use in large repositories\&. Scalar improves performance by configuring advanced Git settings, maintaining repositories in the background, and helping to reduce data sent across the network\&.
  49 .sp
  50 An important Scalar concept is the enlistment: this is the top\-level directory of the project\&. It usually contains the subdirectory \fBsrc/\fR which is a Git worktree\&. This encourages the separation between tracked files (inside \fBsrc/\fR) and untracked files, such as build artifacts (outside \fBsrc/\fR)\&. When registering an existing Git worktree with Scalar whose name is not \fBsrc\fR, the enlistment will be identical to the worktree\&.
  51 .sp
  52 The \fBscalar\fR command implements various subcommands, and different options depending on the subcommand\&. With the exception of \fBclone\fR, \fBlist\fR and \fBreconfigure \-\-all\fR, all subcommands expect to be run in an enlistment\&.
  53 .sp
  54 The following options can be specified \fIbefore\fR the subcommand:
  55 .PP
  56 \-C <directory>
  57 .RS 4
  58 Before running the subcommand, change the working directory\&. This option imitates the same option of
  59 \fBgit\fR(1)\&.
  60 .RE
  61 .PP
  62 \-c <key>=<value>
  63 .RS 4
  64 For the duration of running the specified subcommand, configure this setting\&. This option imitates the same option of
  65 \fBgit\fR(1)\&.
  66 .RE
  67 .SH "COMMANDS"
  68 .SS "Clone"
  69 .PP
  70 clone [<options>] <url> [<enlistment>]
  71 .RS 4
  72 Clones the specified repository, similar to
  73 \fBgit-clone\fR(1)\&. By default, only commit and tree objects are cloned\&. Once finished, the worktree is located at
  74 \fB<enlistment>/src\fR\&.
  75 .sp
  76 The sparse\-checkout feature is enabled (except when run with
  77 \fB\-\-full\-clone\fR) and the only files present are those in the top\-level directory\&. Use
  78 \fBgit sparse\-checkout set\fR
  79 to expand the set of directories you want to see, or
  80 \fBgit sparse\-checkout disable\fR
  81 to expand to all files (see
  82 \fBgit-sparse-checkout\fR(1)
  83 for more details)\&. You can explore the subdirectories outside your sparse\-checkout by using
  84 \fBgit ls\-tree HEAD[:<directory>]\fR\&.
  85 .RE
  86 .PP
  87 \-b <name>, \-\-branch <name>
  88 .RS 4
  89 Instead of checking out the branch pointed to by the cloned repository\(cqs HEAD, check out the
  90 \fB<name>\fR
  91 branch instead\&.
  92 .RE
  93 .PP
  94 \-\-[no\-]single\-branch
  95 .RS 4
  96 Clone only the history leading to the tip of a single branch, either specified by the
  97 \fB\-\-branch\fR
  98 option or the primary branch remote\(cqs
  99 \fBHEAD\fR
 100 points at\&.
 101 .sp
 102 Further fetches into the resulting repository will only update the remote\-tracking branch for the branch this option was used for the initial cloning\&. If the HEAD at the remote did not point at any branch when
 103 \fB\-\-single\-branch\fR
 104 clone was made, no remote\-tracking branch is created\&.
 105 .RE
 106 .PP
 107 \-\-[no\-]src
 108 .RS 4
 109 By default,
 110 \fBscalar clone\fR
 111 places the cloned repository within a
 112 \fB<entlistment>/src\fR
 113 directory\&. Use
 114 \fB\-\-no\-src\fR
 115 to place the cloned repository directly in the
 116 \fB<enlistment>\fR
 117 directory\&.
 118 .RE
 119 .PP
 120 \-\-[no\-]full\-clone
 121 .RS 4
 122 A sparse\-checkout is initialized by default\&. This behavior can be turned off via
 123 \fB\-\-full\-clone\fR\&.
 124 .RE
 125 .SS "List"
 126 .PP
 127 list
 128 .RS 4
 129 List enlistments that are currently registered by Scalar\&. This subcommand does not need to be run inside an enlistment\&.
 130 .RE
 131 .SS "Register"
 132 .PP
 133 register [<enlistment>]
 134 .RS 4
 135 Adds the enlistment\(cqs repository to the list of registered repositories and starts background maintenance\&. If
 136 \fB<enlistment>\fR
 137 is not provided, then the enlistment associated with the current working directory is registered\&.
 138 .sp
 139 Note: when this subcommand is called in a worktree that is called
 140 \fBsrc/\fR, its parent directory is considered to be the Scalar enlistment\&. If the worktree is
 141 \fInot\fR
 142 called
 143 \fBsrc/\fR, it itself will be considered to be the Scalar enlistment\&.
 144 .RE
 145 .SS "Unregister"
 146 .PP
 147 unregister [<enlistment>]
 148 .RS 4
 149 Remove the specified repository from the list of repositories registered with Scalar and stop the scheduled background maintenance\&.
 150 .RE
 151 .SS "Run"
 152 .PP
 153 scalar run ( all | config | commit\-graph | fetch | loose\-objects | pack\-files ) [<enlistment>]
 154 .RS 4
 155 Run the given maintenance task (or all tasks, if
 156 \fBall\fR
 157 was specified)\&. Except for
 158 \fBall\fR
 159 and
 160 \fBconfig\fR, this subcommand simply hands off to
 161 \fBgit-maintenance\fR(1)
 162 (mapping
 163 \fBfetch\fR
 164 to
 165 \fBprefetch\fR
 166 and
 167 \fBpack\-files\fR
 168 to
 169 \fBincremental\-repack\fR)\&.
 170 .sp
 171 These tasks are run automatically as part of the scheduled maintenance, as soon as the repository is registered with Scalar\&. It should therefore not be necessary to run this subcommand manually\&.
 172 .sp
 173 The
 174 \fBconfig\fR
 175 task is specific to Scalar and configures all those opinionated default settings that make Git work more efficiently with large repositories\&. As this task is run as part of
 176 \fBscalar clone\fR
 177 automatically, explicit invocations of this task are rarely needed\&.
 178 .RE
 179 .SS "Reconfigure"
 180 .sp
 181 After a Scalar upgrade, or when the configuration of a Scalar enlistment was somehow corrupted or changed by mistake, this subcommand allows to reconfigure the enlistment\&.
 182 .sp
 183 With the \fB\-\-all\fR option, all enlistments currently registered with Scalar will be reconfigured\&. Use this option after each Scalar upgrade\&.
 184 .SS "Diagnose"
 185 .PP
 186 diagnose [<enlistment>]
 187 .RS 4
 188 When reporting issues with Scalar, it is often helpful to provide the information gathered by this command, including logs and certain statistics describing the data shape of the current enlistment\&.
 189 .sp
 190 The output of this command is a
 191 \fB\&.zip\fR
 192 file that is written into a directory adjacent to the worktree in the
 193 \fBsrc\fR
 194 directory\&.
 195 .RE
 196 .SS "Delete"
 197 .PP
 198 delete <enlistment>
 199 .RS 4
 200 This subcommand lets you delete an existing Scalar enlistment from your local file system, unregistering the repository\&.
 201 .RE
 202 .SH "SEE ALSO"
 203 .sp
 204 \fBgit-clone\fR(1), \fBgit-maintenance\fR(1)\&.
 205 .SH "GIT"
 206 .sp
 207 Part of the \fBgit\fR(1) suite