]> 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:

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