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

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