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

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