<h1>Chit</h1>
<h2><span class="caps">DESCRIPTION</span>:</h2>
<p>Chit is a command line cheat sheet utility based on git.</p>
<h2><span class="caps">FEATURES</span>:</h2>
<p>Chit was inspired by <a href="http://cheat.errtheblog.com/">‘cheat’</a> by Chris Wanstrath. You can use chit to access and manage your cheat sheets easily.</p>
<p>There are several differences between ‘cheat’ and ‘chit’. By using chit, besides the wonderful features of ‘cheat’, you get:</p>
<ol>
<li>Git powered cheat sheet repository. You can specify where you get the sheets and where to share them.</li>
<li>Your own private cheat sheets. Everybody has some project related or smoe cheat sheets which are not mean to public. You can also put them into chit</li>
<li>Directory support. You can group cheat sheets by directory now.</li>
<li>One less letter to type.</li>
</ol>
<h2><span class="caps">SYNOPSIS</span>:</h2>
<p>To initialize chit repositories<br />
<pre><code>$ chit --init</code></pre><br />
This will be run automatically when you run chit for the first time.</p>
<p>To get a cheat sheet:</p>
<pre><code>$ chit [cheatsheet]</code></pre>
<p>If it does not exist, a new one will be created and waiting for your editing. Leave it blank and quit the editor if you don’t want to add a new one.</p>
<p>To edit a cheat sheet, use the —edit switch.</p>
<pre><code>$ chit [cheatsheet] --edit</code></pre>
<p>To add a cheat sheet, use the —add switch.</p>
<pre><code>$ chit [cheatsheet] --add</code></pre>
<p>During editing a cheat sheet, empty the content will get the cheat sheet removed.</p>
<p>A prefix ‘@’ indicates the cheat sheet is in private mode. A private cheat sheet is kept in another repository.</p>
<p>To get a private cheat sheet:</p>
<pre><code>$ chit @[cheatsheet]</code></pre>
<p>The prefix ‘@’ works the same for both —edit and —add.</p>
<p>The cheat sheet can be in a path. For example:</p>
<pre><code>$ chit mysql/select</code></pre>
<p>will get the cheat sheet ‘select’ under mysql.</p>
<p>To show all the cheat sheets:</p>
<pre><code>$ chit [all|sheets]</code></pre>
<p>To show all the private cheat sheets:</p>
<pre><code>$ chit @[all|sheets]</code></pre>
<p>To find cheat sheets begin with ‘name’, use the —find/-f switch</p>
<pre><code>$ chit name --find</code></pre>
<p>To search cheat sheets content with ‘text’, use the —search/-s switch</p>
<pre><code>$ chit text --search</code></pre>
<p>To move or rename a sheet, use ‘—mv/-m’ switch</p>
<pre><code>$ chit zsh_if zsh/if -m</code></pre>
<h2><span class="caps">INSTALL</span>:</h2>
<pre>
<code>
sudo gem install robin-chit -s http://gems.github.com
chit --init
</code>
</pre>
<h2><span class="caps">CONFIGURATION</span>:</h2>
<p>Before run ‘chit’, you may want to config ~/.chitrc which is a <span class="caps">YAML</span> file.</p>
<ul>
<li>root: local path to store the cheat sheet. By default, it is ~/.chit</li>
<li>main:
<ul>
<li>clone-from: where to get the public cheat sheets. You can use git://github.com/robin/chitsheet.git, which is a snap shoot of http://cheat.errtheblog.com/.</li>
</ul></li>
<li>private:
<ul>
<li>clone-from: where to get the private cheat sheets. If not specified, a new git repository will be init for private cheat sheets.</li>
</ul></li>
</ul>
<h2><span class="caps">REQUIREMENTS</span>:</h2>
<ul>
<li>rubygems</li>
<li>git</li>
</ul>
2008-06-21T07:40:55-07:00
29000
user-s-guide
26657
User's Guide
2009-07-26T03:03:42-07:00
108013