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

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