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