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