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 v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-10-04
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.47.0.rc1.33.g90fe3800b9
   8 .\"  Language: English
   9 .\"
  10 .TH "SCALAR" "1" "2024-10-04" "Git 2\&.47\&.0\&.rc1\&.33\&.g9" "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 .SH "DESCRIPTION"
  46 .sp
  47 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\&.
  48 .sp
  49 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\&.
  50 .sp
  51 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\&.
  52 .sp
  53 The following options can be specified \fIbefore\fR the subcommand:
  54 .PP
  55 \-C <directory>
  56 .RS 4
  57 Before running the subcommand, change the working directory\&. This option imitates the same option of
  58 \fBgit\fR(1)\&.
  59 .RE
  60 .PP
  61 \-c <key>=<value>
  62 .RS 4
  63 For the duration of running the specified subcommand, configure this setting\&. This option imitates the same option of
  64 \fBgit\fR(1)\&.
  65 .RE
  66 .SH "COMMANDS"
  67 .SS "Clone"
  68 .PP
  69 clone [<options>] <url> [<enlistment>]
  70 .RS 4
  71 Clones the specified repository, similar to
  72 \fBgit-clone\fR(1)\&. By default, only commit and tree objects are cloned\&. Once finished, the worktree is located at
  73 \fB<enlistment>/src\fR\&.
  74 .sp
  75 The sparse\-checkout feature is enabled (except when run with
  76 \fB\-\-full\-clone\fR) and the only files present are those in the top\-level directory\&. Use
  77 \fBgit sparse\-checkout set\fR
  78 to expand the set of directories you want to see, or
  79 \fBgit sparse\-checkout disable\fR
  80 to expand to all files (see
  81 \fBgit-sparse-checkout\fR(1)
  82 for more details)\&. You can explore the subdirectories outside your sparse\-checkout by using
  83 \fBgit ls\-tree HEAD[:<directory>]\fR\&.
  84 .RE
  85 .PP
  86 \-b <name>, \-\-branch <name>
  87 .RS 4
  88 Instead of checking out the branch pointed to by the cloned repository\(cqs HEAD, check out the
  89 \fB<name>\fR
  90 branch instead\&.
  91 .RE
  92 .PP
  93 \-\-[no\-]single\-branch
  94 .RS 4
  95 Clone only the history leading to the tip of a single branch, either specified by the
  96 \fB\-\-branch\fR
  97 option or the primary branch remote\(cqs
  98 \fBHEAD\fR
  99 points at\&.
 100 .sp
 101 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
 102 \fB\-\-single\-branch\fR
 103 clone was made, no remote\-tracking branch is created\&.
 104 .RE
 105 .PP
 106 \-\-[no\-]src
 107 .RS 4
 108 By default,
 109 \fBscalar clone\fR
 110 places the cloned repository within a
 111 \fB<entlistment>/src\fR
 112 directory\&. Use
 113 \fB\-\-no\-src\fR
 114 to place the cloned repository directly in the
 115 \fB<enlistment>\fR
 116 directory\&.
 117 .RE
 118 .PP
 119 \-\-[no\-]tags
 120 .RS 4
 121 By default,
 122 \fBscalar clone\fR
 123 will fetch the tag objects advertised by the remote and future
 124 \fBgit fetch\fR
 125 commands will do the same\&. Use
 126 \fB\-\-no\-tags\fR
 127 to avoid fetching tags in
 128 \fBscalar clone\fR
 129 and to configure the repository to avoid fetching tags in the future\&. To fetch tags after cloning with
 130 \fB\-\-no\-tags\fR, run
 131 \fBgit fetch \-\-tags\fR\&.
 132 .RE
 133 .PP
 134 \-\-[no\-]full\-clone
 135 .RS 4
 136 A sparse\-checkout is initialized by default\&. This behavior can be turned off via
 137 \fB\-\-full\-clone\fR\&.
 138 .RE
 139 .SS "List"
 140 .PP
 141 list
 142 .RS 4
 143 List enlistments that are currently registered by Scalar\&. This subcommand does not need to be run inside an enlistment\&.
 144 .RE
 145 .SS "Register"
 146 .PP
 147 register [<enlistment>]
 148 .RS 4
 149 Adds the enlistment\(cqs repository to the list of registered repositories and starts background maintenance\&. If
 150 \fB<enlistment>\fR
 151 is not provided, then the enlistment associated with the current working directory is registered\&.
 152 .sp
 153 Note: when this subcommand is called in a worktree that is called
 154 \fBsrc/\fR, its parent directory is considered to be the Scalar enlistment\&. If the worktree is
 155 \fInot\fR
 156 called
 157 \fBsrc/\fR, it itself will be considered to be the Scalar enlistment\&.
 158 .RE
 159 .SS "Unregister"
 160 .PP
 161 unregister [<enlistment>]
 162 .RS 4
 163 Remove the specified repository from the list of repositories registered with Scalar and stop the scheduled background maintenance\&.
 164 .RE
 165 .SS "Run"
 166 .PP
 167 scalar run ( all | config | commit\-graph | fetch | loose\-objects | pack\-files ) [<enlistment>]
 168 .RS 4
 169 Run the given maintenance task (or all tasks, if
 170 \fBall\fR
 171 was specified)\&. Except for
 172 \fBall\fR
 173 and
 174 \fBconfig\fR, this subcommand simply hands off to
 175 \fBgit-maintenance\fR(1)
 176 (mapping
 177 \fBfetch\fR
 178 to
 179 \fBprefetch\fR
 180 and
 181 \fBpack\-files\fR
 182 to
 183 \fBincremental\-repack\fR)\&.
 184 .sp
 185 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\&.
 186 .sp
 187 The
 188 \fBconfig\fR
 189 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
 190 \fBscalar clone\fR
 191 automatically, explicit invocations of this task are rarely needed\&.
 192 .RE
 193 .SS "Reconfigure"
 194 .sp
 195 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\&.
 196 .sp
 197 With the \fB\-\-all\fR option, all enlistments currently registered with Scalar will be reconfigured\&. Use this option after each Scalar upgrade\&.
 198 .SS "Diagnose"
 199 .PP
 200 diagnose [<enlistment>]
 201 .RS 4
 202 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\&.
 203 .sp
 204 The output of this command is a
 205 \fB\&.zip\fR
 206 file that is written into a directory adjacent to the worktree in the
 207 \fBsrc\fR
 208 directory\&.
 209 .RE
 210 .SS "Delete"
 211 .PP
 212 delete <enlistment>
 213 .RS 4
 214 This subcommand lets you delete an existing Scalar enlistment from your local file system, unregistering the repository\&.
 215 .RE
 216 .SH "SEE ALSO"
 217 .sp
 218 \fBgit-clone\fR(1), \fBgit-maintenance\fR(1)\&.
 219 .SH "GIT"
 220 .sp
 221 Part of the \fBgit\fR(1) suite