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

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