docs/02-quickstart.markdown @ 16aa2def1d5b
default tip
Update to work with Python 3
The Hamster Wheel of Backwards Incompatibility turns ever onward. This probably
breaks support for Python 2, but at this point I don't care. I just can't
summon up the willpower to do anything more than the most basic unfucking of
this thing that's been finished for 11 years but still breaks constantly because
of Mercurial's API churn and Python 3 setting the world on fire.
The
_ _ ____ _ _ ____ ___ ____ ____ _ _ _ _ _ ____ ____ _ ____ ____ ___ ____ ____ _ _ _ _ _ ____ ____ ___ ____ _ _ _ ____ ____ _ _ ___ ____ ___ _ ___ _ _ _ ___ _ _
|__| |__| |\/| [__ | |___ |__/ | | | |__| |___ |___ | | | |___ |__] |__| | |_/ | | | |__| |__/ | \ [__ | |\ | | | | |\/| |__] |__| | | |__] | | | | \_/
| | | | | | ___] | |___ | \ |_|_| | | |___ |___ |___ |__| | |__] | | |___ | \_ |_|_| | | | \ |__/ ___] | | \| |___ |__| | | | | | | | |__] | |___ | | |
turns forever
| author |
Steve Losh <steve@stevelosh.com> |
| date |
Tue, 06 Apr 2021 12:55:48 -0400 |
| parents |
25b0cf6b43f5 |
| children |
(none) |
Quick Start
===========
This guide will get you up and running so you can put some useful information
into your shell prompt.
If you haven't already [installed][install] it, do that now.
[install]: ../installation/
[TOC]
A Simple (But Useful) Prompt
----------------------------
Edit your `~/.bashrc` file to include something like this:
hg_ps1() {
hg prompt "{ on {branch}}{ at {bookmark}}{status}" 2> /dev/null
}
export PS1='\u at \h in \w$(hg_ps1)\n$ '
`source ~/.bashrc` after to test it out. Make sure you're in a Mercurial
repository or you won't see anything. This little prompt will give you
something like this:
steve at myhost in ~/src/hg-prompt on default at feature-bookmark?
$
An Advanced Prompt
------------------
How about something a little more interesting?
hg_ps1() {
hg prompt "{[+{incoming|count}]-->}{root|basename}{/{branch}}{-->[+{outgoing|count}]}{ at {bookmark}}{status}" 2> /dev/null
}
export PS1='$(hg_ps1)\n\u at \h in \w\n$ '
And the result (this example assumes one incoming changeset and two outgoing):
[+1]-->hg-prompt/default-->[+2] at feature-bookmark
steve at myhost in ~/src/hg-prompt
$
Learn More
----------
From here you can take a look at the [full documentation][] to see all the
interesting things `hg-prompt` can do.
[full documentation]: ../full-documentation/