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

8df73395a2696681cc52ee426ced1bfd3065a0f9
[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 3.4), 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 that
88 contain the commands to manage (checkout, update etc.) a single repository.
89 vcsh repo configs end in .vcsh, git configs end in .git, etc. This is optional
90 and your preference. For example, this is what a zsh.mrconfig with read-only
91 access to my zshrc repo looks likes. I.e. in this specific example, push can
92 not work.
93
94     [$XDG_CONFIG_HOME/vcsh/repo.d/zsh.git]
95     checkout = vcsh clone 'git://github.com/RichiH/zshrc.git' zsh
96     update   = vcsh run zsh git pull
97     push     = vcsh run zsh git push
98     status   = vcsh run zsh git status
99     gc       = vcsh run zsh git gc
100
101 ### config.d ###
102
103 $XDG_CONFIG_HOME/mr/available.d contains *all available* repositories. Only
104 files/links present in mr/config.d, however, will be used by mr. That means
105 that in this example, only the zsh, gitconfigs, tmux and vim repositories will
106 be checked out. A simple `mr update` run in $HOME will clone or update those
107 four repositories listed in config.d.
108
109 ### ~/.mrconfig ###
110
111 Finally, ~/.mrconfig will tie together all those single files which will allow
112 you to conveniently run `mr up` etc. to manage all repositories. It looks like
113 this:
114
115     [DEFAULT]
116     jobs = 5
117     include = cat $XDG_CONFIG_HOME/mr/config.d/*
118
119 ### repo.d ###
120
121 $XDG_CONFIG_HOME/vcsh/repo.d is the directory where all git repositories which
122 are under vcsh's control are located. Since their working trees are configured
123 to be in $HOME, the files contained in those repositories will be put in $HOME
124 directly.
125 Of course, [mr] [1] will work with this layout if configured according to this
126 document (see above).
127
128 vcsh will check if any file it would want to create exists. If it exists, vcsh
129 will throw a warning and exit. Move away your old config and try again.
130 Optionally, merge your local and your global configs afterwards and push with
131 `vcsh run foo git push`.
132
133 ## 2.3 Moving into a New Host ##
134
135 To illustrate further, the following steps could move your desired
136 configuration to a new host.
137
138 1. Clone the mr repository (containing available.d, config.d etc.); for
139    example: `vcsh clone git://github.com/RichiH/vcsh_mr_template.git`
140 2. Choose your repositories by linking them in config.d (or go with the default
141    you may have already configured by adding symlinks to git).
142 3. Run mr to clone the repositories: `cd; mr update`.
143 4. Done.
144
145 Hopefully the above could help explain how this approach saves time by
146
147 1. making it easy to manage, clone and update a large number of repositories
148    (thanks to mr) and
149 2. making it unnecessary to create symbolic links in $HOME (thanks to vcsh).
150
151 If you want to give vcsh a try, follow the instructions below.
152
153 # 3 Getting Started #
154
155 Below, you will find a few different methods for setting up vcsh:
156
157 3.1. The Template Way
158 3.2. The Steal-from-Template Way
159 3.3. The Manual Way
160
161 ### 3.1 The Template Way ###
162
163 #### 3.1.1 Prerequisites ####
164
165 Make sure none of the following files and directories exist for your test
166 (user). If they do, move them away for now:
167
168 * ~/.gitignore
169 * ~/.mrconfig
170 * $XDG_CONFIG_HOME/mr/available.d/mr.vcsh
171 * $XDG_CONFIG_HOME/mr/available.d/zsh.vcsh
172 * $XDG_CONFIG_HOME/mr/config.d/mr.vcsh
173 * $XDG_CONFIG_HOME/vcsh/repo.d/mr.git/
174
175 All of the files are part of the template repository, the directory is where
176 the template will be stored.
177
178     apt-get install mr
179
180 #### 3.1.2 Clone the Template ####
181
182     mkdir -p ~/work/git
183     cd !$
184     git clone git://github.com/RichiH/vcsh.git vcsh
185     cd vcsh
186     ln -s vcsh /usr/local/bin        # or add it to your PATH
187     cd
188     vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr.vcsh
189
190 #### 3.1.3 Enable Your Test Repository ####
191
192     mv ~/.zsh   ~/zsh.bak
193     mv ~/.zshrc ~/zshrc.bak
194     cd $XDG_CONFIG_HOME/mr/config.d/
195     ln -s ../available.d/zsh.vcsh .  # link, and thereby enable, the zsh repository
196     cd
197     mr up
198
199 #### 3.1.4 Set Up Your Own Repositories ####
200
201 Now, it's time to edit the template config and fill it with your own remotes:
202
203     vim $XDG_CONFIG_HOME/mr/available.d/mr.vcsh
204     vim $XDG_CONFIG_HOME/mr/available.d/zsh.vcsh
205
206 And then create your own stuff:
207
208     vcsh init foo
209     vcsh run foo git add -f bar baz quux
210     vcsh run foo git remote add origin git://quuux
211     vcsh run foo git commit
212     vcsh run foo git push
213
214     cp $XDG_CONFIG_HOME/mr/available.d/mr.vcsh $XDG_CONFIG_HOME/mr/available.d/foo.vcsh
215     vim $XDG_CONFIG_HOME/mr/available.d/foo.vcsh # add your own repo
216
217 Done!
218
219 ### 3.2 The Steal-from-Template Way ###
220
221 You're welcome to clone the example repository:
222
223     git clone git://github.com/RichiH/vcsh_mr_template.git
224
225 Look around in the clone. It should be reasonably simple to understand. If not,
226 poke me, RichiH, on Freenode (query) or OFTC (#vcs-home).
227
228
229 ### 3.3 The Manual Way ###
230
231 This is how my old setup procedure looked like. Adapt it to your own style or
232 copy mine verbatim, either is fine.
233
234     # Create workspace
235     mkdir -p ~/work/git
236     cd !$
237
238     # Clone vcsh and make it available
239     git clone git://github.com/RichiH/vcsh.git vcsh
240     sudo ln -s ~/work/git/vcsh/vcsh /usr/bin/local
241     hash -r
242
243 Grab my mr config. see below for details on how I set this up
244
245     vcsh clone ssh://<remote>/mr.git
246     cd $XDG_CONFIG_HOME/mr/config.d/
247     ln -s ../available.d/* .
248
249
250 mr is used to actually retrieve configs, etc
251
252     ~ % cat ~/.mrconfig
253     [DEFAULT]
254     include = cat $XDG_CONFIG_HOME/mr/config.d/*
255     ~ % echo $XDG_CONFIG_HOME
256     /home/richih/.config
257     ~ % ls $XDG_CONFIG_HOME/mr/available.d # random selection of my repos
258     git-annex gitk.vcsh git.vcsh ikiwiki mr.vcsh reportbug.vcsh snippets.git wget.vcsh zsh.vcsh
259     ~ %
260     # then simply ln -s whatever you want on your local machine from
261     # $XDG_CONFIG_HOME/mr/available.d to $XDG_CONFIG_HOME/mr/config.d
262     ~ % cd
263     ~ % mr -j 5 up
264
265 # 4 Usage #
266
267 ### 4.1 Keeping repositories Up-to-Date ###
268
269 This is the beauty of it all. Once you are set up, just run:
270
271     mr up
272     mr push
273
274 Neat.
275
276 ### 4.1 Making Changes ###
277
278 After you have made some changes, for which you would normally use `git add`
279 and `git commit`, use the vcsh wrapper (like above):
280
281     vcsh run foo git add -f bar baz quux
282     vcsh run foo git commit
283     vcsh run foo git push
284
285 By the way, you'll have to use -f/--force flag with git-add because all files
286 will be ignored by default. This is to show you only useful output when running
287 git-status. A fix for this problem is being worked on.
288
289 ### 4.3 Using vcsh without mr ###
290
291 vcsh encourages you to use mr. It helps you manage a large number of
292 repositories by running the necessary vcsh commands for you. You may choose not
293 to use mr, in which case you will have to run those commands manually or by
294 other means.
295
296 #### A Few Examples ####
297
298 To initialize a new repository: `vcsh init zsh`
299
300 To clone a repository: `vcsh clone ssh://<remote>/zsh.git`
301
302 To interact with a repository, use the regular Git commands, but prepend them
303 with `vcsh run $repository_name`. For example:
304
305     vcsh run zsh git status
306     vcsh run zsh git add -f .zshrc
307     vcsh run zsh git commit
308
309 Obviously, without mr keeping repositories up-to-date, it will have to be done
310 manually. Alternatively, you could try something like this:
311
312     for repo in `vcsh list`; do
313         vcsh run $repo git pull;
314     done
315
316 ----------
317
318 mr can be found at: [http://kitenet.net/~joey/code/mr/][1]
319
320 [1]: http://kitenet.net/~joey/code/mr/ (http://kitenet.net/~joey/code/mr/)