Mercurial Quick Start Cheatsheet

Andrew Bolster

Senior R&D Manager (Data Science) at Synopsys Software Integrity Group and Treasurer @ Bsides Belfast and NI OpenGovernment Network

I hadn’t used Mercurial before so I thought it might be a good idea to leave a reminder for me and anyone else who comes across it…

For tidyness, I do all of my dev-stuff (Subversion, Mercurial, CVS, Git etc) under ~/src and only take root privileges when its needed; any good makefile should relocate the necessary files for you at the ‘make install’ or equivalent point.

Update:This article was picked up by the guys at and I’m really honoured to be included in a site that I’ve been dipping into over the years, so if you need any kind of cheat sheet or quick reference, I highly recommend checking them out. Anyway…

To start off, you should add some form of identification to your ~/.hgrc file

$ cat ~/.hgrc
username = User Name

Now you can connect to $HOSTNAME and grab a clone of $PROJECT for you to work on

$ hg clone http://$HOSTNAME/repo/$PROJECT

Now you can work away, but if you add any files, remember before you commit back to the server to add the new files into the project manifest;

$ hg add $ADDFILES

Once you’ve made your changes, commit and push them back to the host with an appropriate comment.

$ hg commit -m 'I added $ADDFILES to extend/fix/etc'
$ hg push

If you dont want to make any changes, but you’ve clones a project (say to install something…) and 6 months later you want to update it, you don’t have to delete and recreate the directory;

$ hg pull  http://$HOSTNAME/repo/$PROJECT
pulling from  http://$HOSTNAME/repo/$PROJECT
$ hg update
X files updated, X files merged, X files removed, X files unresolved

Of course, this assumed you haven’t been tinkering with the code, in which case update will generally override your changes and reproduce whatever is currently sitting on the project server. If you want to merge, do so!

$ hg merge

For more interesting commands such as

hg log; hg status

and more, consult the man pages… of if you’re looking for serious detail, check out ‘The Definitive Guide’ by fellow island-man, Bryan O’Sullivan

blog comments powered by Disqus