]> git.madduck.net Git - code/vcsh.git/blob - README.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

c0b7cd3ff7ca6b92619a79ce2ed34fd508baf0d3
[code/vcsh.git] / README.md
1 vcsh - Version Control System for $HOME - multiple Git repositories in $HOME
2
3
4 # Index
5
6 1. [30 second howto](#30-second-howto)
7 2. [Introduction](#introduction)
8 3. [Usage Exmaples](#usage-examples)
9 4. [Overview](#overview)
10 5. [Getting Started](#getting-started)
11 6. [Contact](#contact)
12
13
14 # 30 second howto
15
16 While it may appear that there's an overwhelming amount of documentation and
17 while the explanation of the concepts behind `vcsh` needs to touch a few gory
18 details of `git` internals, getting started with `vcsh` is extremely simple.
19
20 Let's say you want to version control your `vim` configuration:
21
22     vcsh init vim
23     vcsh vim add ~/.vimrc ~/.vim
24     vcsh vim commit -m 'Initial commit of my Vim configuration'
25     # optionally push your files to a remote
26     vcsh vim remote add origin <remote>
27     vcsh vim push -u origin master
28     # from now on you can push additional commits like this
29     vcsh vim push
30
31 If all that looks a _lot_ like standard `git`, that's no coincidence; it's
32 a design feature.
33
34
35 # Introduction
36
37 [vcsh][vcsh] allows you to maintain several Git repositories in one single
38 directory. They all maintain their working trees without clobbering each other
39 or interfering otherwise. By default, all Git repositories maintained via
40 `vcsh` store the actual files in `$HOME` but you can override this setting if
41 you want to.
42 All this means that you can have one repository per application or application
43 family, i.e. `zsh`, `vim`, `ssh`, etc. This, in turn, allows you to clone
44 custom sets of configurations onto different machines or even for different
45 users; picking and mixing which configurations you want to use where.
46 For example, you may not need to have your `mplayer` configuration on a server
47 or available to root and you may want to maintain different configuration for
48 `ssh` on your personal and your work machines.
49
50 A lot of modern UNIX-based systems offer pacakges for `vcsh`. In case yours
51 does not read `INSTALL.md` for install instructions or `PACKAGING.md` to create
52 a package, yourself. If you do end up packaging `vcsh` please let us know so we
53 can give you your own packaging branch in the upstream repository.
54
55 ## Talks
56
57 Some people found it useful to look at slides and videos explaining how `vcsh`
58 works instead of working through the docs.
59 All slides, videos, and further information can be found
60 [on the author's talk page][talks].
61
62
63 # Usage Examples
64
65 There are three different ways to interact with `vcsh` repositories; this
66 section will only show the simplest and easiest way.
67 Certain more advanced use cases require the other two ways, but don't worry
68 about this for now. This will be covered in the advanced sections.
69
70 ## Initialize a new repository "vim"
71
72     vcsh init vim
73
74 ## Clone an existing repository
75
76     vcsh clone <remote> <repository_name>
77
78 ## Add files to repository "vim"
79
80     vcsh vim add ~/.vimrc ~/.vim
81     vcsh vim commit -m 'Update Vim configuration'
82
83 ## Add a remote for repository "vim"
84
85     vcsh vim remote add origin <remote>
86     vcsh vim push origin master:master
87     vcsh vim branch --track master origin/master
88
89 ## Push to remote of repository "vim"
90
91     vcsh vim push
92
93 ## Pull from remote of repository "vim"
94
95     vcsh vim pull
96
97
98
99 # Overview
100
101 ## From zero to vcsh
102
103 You put a lot of effort into your configuration and want to both protect and
104 distribute this configuration.
105
106 Most people who decide to put their dotfiles under version control start with a
107 single repository in `$HOME`, adding all their dotfiles (and possibly more)
108 to it. This works, of course, but can become a nuisance as soon as you try to
109 manage more than one host.
110
111 The next logical step is to create single-purpose repositories in, for example,
112 `~/.dotfiles` and to create symbolic links into `$HOME`. This gives you the
113 flexibility to check out only certain repositories on different hosts. The
114 downsides of this approach are the necessary manual steps of cloning and
115 symlinking the individual repositories.
116
117 `vcsh` takes this approach one step further. It enables single-purpose
118 repositories and stores them in a hidden directory. However, it does not create
119 symbolic links in `$HOME`; it puts the actual files right into `$HOME`.
120
121 As `vcsh` allows you to put an arbitrary number of distinct repositories into
122 your `$HOME`, you will end up with a lot of repositories very quickly.
123
124 To manage both `vcsh` and other repositories, we suggest using [mr](mr). `mr`
125 takes care of pulling in and pushing out new data for a variety of version
126 control systems.
127
128 `vcsh` was designed with [mr][mr], a tool to manage Multiple Repositories, in
129 mind and the two integrate very nicely. `mr` has native support for `vcsh`
130 repositories and to `vcsh`, `mr` is just another configuration to track.
131 This make setting up any new machine a breeze. It takes literally less than
132 five minutes to go from standard installation to fully set up system
133
134 This is where `mr` comes in. While the use of `mr` is technically
135 optional, but it will be an integral part of the proposed system that follows.
136
137 ## Default Directory Layout
138
139 To illustrate, this is what a possible directory structure looks like.
140
141     $HOME
142         |-- $XDG_CONFIG_HOME (defaults to $HOME/.config)
143         |   |-- mr
144         |   |   |-- available.d
145         |   |   |   |-- zsh.vcsh
146         |   |   |   |-- gitconfigs.vcsh
147         |   |   |   |-- lftp.vcsh
148         |   |   |   |-- offlineimap.vcsh
149         |   |   |   |-- s3cmd.vcsh
150         |   |   |   |-- tmux.vcsh
151         |   |   |   |-- vim.vcsh
152         |   |   |   |-- vimperator.vcsh
153         |   |   |   `-- snippets.git
154         |   |   `-- config.d
155         |   |       |-- zsh.vcsh        -> ../available.d/zsh.vcsh
156         |   |       |-- gitconfigs.vcsh -> ../available.d/gitconfigs.vcsh
157         |   |       |-- tmux.vcsh       -> ../available.d/tmux.vcsh
158         |   |       `-- vim.vcsh        -> ../available.d/vim.vcsh
159         |   `-- vcsh
160         |       |-- config
161         |       `-- repo.d
162         |           |-- zsh.git  -----------+
163         |           |-- gitconfigs.git      |
164         |           |-- tmux.git            |
165         |           `-- vim.git             |
166         |-- [...]                           |
167         |-- .zshrc   <----------------------+
168         |-- .gitignore.d
169         |   `-- zsh
170         |-- .mrconfig
171         `-- .mrtrust
172
173 ### available.d
174
175 The files you see in $XDG\_CONFIG\_HOME/mr/available.d are mr configuration files
176 that contain the commands to manage (checkout, update etc.) a single
177 repository. vcsh repo configs end in .vcsh, git configs end in .git, etc. This
178 is optional and your preference. For example, this is what a zsh.vcsh
179 with read-only access to my zshrc repo looks likes. I.e. in this specific
180 example, push can not work as you will be using the author's repository. This
181 is for demonstration, only. Of course, you are more than welcome to clone from
182 this repository and fork your own.
183
184     [$XDG_CONFIG_HOME/vcsh/repo.d/zsh.git]
185     checkout = vcsh clone 'git://github.com/RichiH/zshrc.git' zsh
186     update   = vcsh run zsh git pull
187     push     = vcsh run zsh git push
188     status   = vcsh run zsh git status
189     gc       = vcsh run zsh git gc
190
191 ### config.d
192
193 $XDG\_CONFIG\_HOME/mr/available.d contains *all available* repositories. Only
194 files/links present in mr/config.d, however, will be used by mr. That means
195 that in this example, only the zsh, gitconfigs, tmux and vim repositories will
196 be checked out. A simple `mr update` run in $HOME will clone or update those
197 four repositories listed in config.d.
198
199 ### ~/.mrconfig
200
201 Finally, ~/.mrconfig will tie together all those single files which will allow
202 you to conveniently run `mr up` etc. to manage all repositories. It looks like
203 this:
204
205     [DEFAULT]
206     jobs = 5
207     # Use if your mr does not have vcsh support in mainline, yet
208     include = cat /usr/share/mr/vcsh
209     include = cat ${XDG_CONFIG_HOME:-$HOME/.config}/mr/config.d/*
210
211 ### repo.d
212
213 $XDG\_CONFIG\_HOME/vcsh/repo.d is the directory where all git repositories which
214 are under vcsh's control are located. Since their working trees are configured
215 to be in $HOME, the files contained in those repositories will be put in $HOME
216 directly.
217 Of course, [mr] [mr] will work with this layout if configured according to this
218 document (see above).
219
220 vcsh will check if any file it would want to create exists. If it exists, vcsh
221 will throw a warning and exit. Move away your old config and try again.
222 Optionally, merge your local and your global configs afterwards and push with
223 `vcsh run foo git push`.
224
225 ## Moving into a New Host
226
227 To illustrate further, the following steps could move your desired
228 configuration to a new host.
229
230 1. Clone the mr repository (containing available.d, config.d etc.); for
231    example: `vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr`
232 2. Choose your repositories by linking them in config.d (or go with the default
233    you may have already configured by adding symlinks to git).
234 3. Make sure the line 'include = cat /usr/share/mr/vcsh' in .mrconfig points
235    to an existing file
236 4. Run mr to clone the repositories: `cd; mr update`.
237 5. Done.
238
239 Hopefully the above could help explain how this approach saves time by
240
241 1. making it easy to manage, clone and update a large number of repositories
242    (thanks to mr) and
243 2. making it unnecessary to create symbolic links in $HOME (thanks to vcsh).
244
245 If you want to give vcsh a try, follow the instructions below.
246
247
248 # Getting Started
249
250 Below, you will find a few different methods for setting up vcsh:
251
252 1. The Template Way
253 2. The Steal-from-Template Way
254 3. The Manual Way
255
256 ### The Template Way
257
258 #### Prerequisites
259
260 Make sure none of the following files and directories exist for your test
261 (user). If they do, move them away for now:
262
263 * ~/.gitignore.d
264 * ~/.mrconfig
265 * $XDG\_CONFIG\_HOME/mr/available.d/mr.vcsh
266 * $XDG\_CONFIG\_HOME/mr/available.d/zsh.vcsh
267 * $XDG\_CONFIG\_HOME/mr/config.d/mr.vcsh
268 * $XDG\_CONFIG\_HOME/vcsh/repo.d/mr.git/
269
270 All of the files are part of the template repository, the directory is where
271 the template will be stored.
272
273     apt-get install mr
274
275 #### Install vcsh
276
277 #### Debian
278
279 If you are using Debian Squeeze, you will need to enable backports
280
281     apt-get install vcsh
282
283 #### Arch Linux
284
285 vcsh is availabe via [AUR](https://aur.archlinux.org/packages.php?ID=54164)
286 and further documentation about the use of AUR is available
287 [on Arch's wiki](https://wiki.archlinux.org/index.php/Arch_User_Repository).
288
289     cd /var/abs/local/
290     wget https://aur.archlinux.org/packages/vc/vcsh-git/vcsh-git.tar.gz
291     tar xfz vcsh-git.tar.gz
292     cd vcsh-git
293     makepkg -s
294     pacman -U vcsh*.pkg.tar.xz
295
296 #### From source
297
298 If your version of mr is older than version 1.07, make sure to put
299
300     include = cat /usr/share/mr/vcsh
301
302 into your .mrconfig .
303
304     # choose a location for your checkout
305     cd $HOME
306     mkdir -p ~/work/git
307     git clone git://github.com/RichiH/vcsh.git
308     cd vcsh
309     ln -s vcsh /usr/local/bin                       # or add it to your PATH
310     cd
311
312 #### Clone the Template
313
314     vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr
315
316 #### Enable Your Test Repository
317
318     mv ~/.zsh   ~/zsh.bak
319     mv ~/.zshrc ~/zshrc.bak
320     cd $XDG_CONFIG_HOME/mr/config.d/
321     ln -s ../available.d/zsh.vcsh .  # link, and thereby enable, the zsh repository
322     cd
323     mr up
324
325 #### Set Up Your Own Repositories
326
327 Now, it's time to edit the template config and fill it with your own remotes:
328
329     vim $XDG_CONFIG_HOME/mr/available.d/mr.vcsh
330     vim $XDG_CONFIG_HOME/mr/available.d/zsh.vcsh
331
332 And then create your own stuff:
333
334     vcsh init foo
335     vcsh run foo git add -f bar baz quux
336     vcsh run foo git remote add origin git://quuux
337     vcsh run foo git commit
338     vcsh run foo git push
339
340     cp $XDG_CONFIG_HOME/mr/available.d/mr.vcsh $XDG_CONFIG_HOME/mr/available.d/foo.vcsh
341     vim $XDG_CONFIG_HOME/mr/available.d/foo.vcsh # add your own repo
342
343 Done!
344
345 ### The Steal-from-Template Way
346
347 You're welcome to clone the example repository:
348
349     vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr
350     # make sure 'include = cat /usr/share/mr/vcsh' points to an exiting file
351     vim .mrconfig
352
353 Look around in the clone. It should be reasonably simple to understand. If not,
354 poke me, RichiH, on Freenode (query) or OFTC (#vcs-home).
355
356
357 ### The Manual Way
358
359 This is how my old setup procedure looked like. Adapt it to your own style or
360 copy mine verbatim, either is fine.
361
362     # Create workspace
363     mkdir -p ~/work/git
364     cd !$
365
366     # Clone vcsh and make it available
367     git clone git://github.com/RichiH/vcsh.git vcsh
368     sudo ln -s ~/work/git/vcsh/vcsh /usr/bin/local
369     hash -r
370
371 Grab my mr config. see below for details on how I set this up
372
373     vcsh clone ssh://<remote>/mr.git
374     cd $XDG_CONFIG_HOME/mr/config.d/
375     ln -s ../available.d/* .
376
377
378 mr is used to actually retrieve configs, etc
379
380     ~ % cat ~/.mrconfig
381     [DEFAULT]
382     # adapt /usr/share/mr/vcsh to your system if needed
383     include = cat /usr/share/mr/vcsh
384     include = cat $XDG_CONFIG_HOME/mr/config.d/*
385     ~ % echo $XDG_CONFIG_HOME
386     /home/richih/.config
387     ~ % ls $XDG_CONFIG_HOME/mr/available.d # random selection of my repos
388     git-annex gitk.vcsh git.vcsh ikiwiki mr.vcsh reportbug.vcsh snippets.git wget.vcsh zsh.vcsh
389     ~ %
390     # then simply ln -s whatever you want on your local machine from
391     # $XDG_CONFIG_HOME/mr/available.d to $XDG_CONFIG_HOME/mr/config.d
392     ~ % cd
393     ~ % mr -j 5 up
394
395
396 # mr usage ; will be factored out & rewritten
397
398 ### Keeping repositories Up-to-Date
399
400 This is the beauty of it all. Once you are set up, just run:
401
402     mr up
403     mr push
404
405 Neat.
406
407 ### Making Changes
408
409 After you have made some changes, for which you would normally use `git add`
410 and `git commit`, use the vcsh wrapper (like above):
411
412     vcsh run foo git add -f bar baz quux
413     vcsh run foo git commit
414     vcsh run foo git push
415
416 By the way, you'll have to use -f/--force flag with git-add because all files
417 will be ignored by default. This is to show you only useful output when running
418 git-status. A fix for this problem is being worked on.
419
420 ### Using vcsh without mr
421
422 vcsh encourages you to use [mr][mr]. It helps you manage a large number of
423 repositories by running the necessary vcsh commands for you. You may choose not
424 to use mr, in which case you will have to run those commands manually or by
425 other means.
426
427
428 To initialize a new repository: `vcsh init zsh`
429
430 To clone a repository: `vcsh clone ssh://<remote>/zsh.git`
431
432 To interact with a repository, use the regular Git commands, but prepend them
433 with `vcsh run $repository_name`. For example:
434
435     vcsh run zsh git status
436     vcsh run zsh git add -f .zshrc
437     vcsh run zsh git commit
438
439 Obviously, without mr keeping repositories up-to-date, it will have to be done
440 manually. Alternatively, you could try something like this:
441
442     for repo in `vcsh list`; do
443         vcsh run $repo git pull;
444     done
445
446
447 # Contact
448
449 There are several ways to get in touch with the author and a small but committed
450 community around the general idea of version controlling your (digital) life.
451
452 * IRC: #vcs-home on irc.oftc.net
453
454 * Mailing list: [http://lists.madduck.net/listinfo/vcs-home][vcs-home-list]
455
456 * Pull requests or issues on [https://github.com/RichiH/vcsh][vcsh]
457
458
459 [mr]: http://kitenet.net/~joey/code/mr/
460 [talks]: http://richardhartmann.de/talks/
461 [vcsh]: https://github.com/RichiH/vcsh
462 [vcs-home-list]: http://lists.madduck.net/listinfo/vcs-home