---
title: Documentation
layout: page
section: documentation
---

<h2>Documentation</h2>

<div class="row">

  <div class="span4">
    <h3>Quick Start</h3>
    <div class="well well-large">
      <p>
        Trying ppl for the first time?
        <br />
        Want to learn the basics?
        <br />
        In 30 seconds or less?
      </p>

      <p>
        <a class="btn btn-primary" href="{{site.url}}/documentation/quick-start">
          Get Started
        </a>
      </p>

    </div>
  </div>

  <div class="span8">
    <h3>Command Reference</h3>

    <div class="row">

      <div class="span2">
        <ul class="nav nav-pills nav-stacked">
          <li><a href="{{site.url}}/documentation/commands/age">age</a></li>
          <li><a href="{{site.url}}/documentation/commands/add">add</a></li>
          <li><a href="{{site.url}}/documentation/commands/bday">bday</a></li>
          <li><a href="{{site.url}}/documentation/commands/completion">completion</a></li>
          <li><a href="{{site.url}}/documentation/commands/email">email</a></li>
          <li><a href="{{site.url}}/documentation/commands/grep">grep</a></li>
        </ul>
      </div>

      <div class="span2">
        <ul class="nav nav-pills nav-stacked">
          <li><a href="{{site.url}}/documentation/commands/init">init</a></li>
          <li><a href="{{site.url}}/documentation/commands/ls">ls</a></li>
          <li><a href="{{site.url}}/documentation/commands/mutt">mutt</a></li>
          <li><a href="{{site.url}}/documentation/commands/mv">mv</a></li>
          <li><a href="{{site.url}}/documentation/commands/name">name</a></li>
          <li><a href="{{site.url}}/documentation/commands/nick">nick</a></li>
        </ul>
      </div>

      <div class="span2">
        <ul class="nav nav-pills nav-stacked">
          <li><a href="{{site.url}}/documentation/commands/org">org</a></li>
          <li><a href="{{site.url}}/documentation/commands/phone">phone</a></li>
          <li><a href="{{site.url}}/documentation/commands/post">post</a></li>
          <li><a href="{{site.url}}/documentation/commands/pull">pull</a></li>
          <li><a href="{{site.url}}/documentation/commands/push">push</a></li>
          <li><a href="{{site.url}}/documentation/commands/remote">remote</a></li>
        </ul>
      </div>

      <div class="span2">
        <ul class="nav nav-pills nav-stacked">
          <li><a href="{{site.url}}/documentation/commands/rm">rm</a></li>
          <li><a href="{{site.url}}/documentation/commands/scrape">scrape</a></li>
          <li><a href="{{site.url}}/documentation/commands/shell">shell</a></li>
          <li><a href="{{site.url}}/documentation/commands/show">show</a></li>
          <li><a href="{{site.url}}/documentation/commands/url">url</a></li>
          <li><a href="{{site.url}}/documentation/commands/version">version</a></li>
        </ul>
      </div>

    </div>

  </div>

</div>


<div class="row">

  <div class="span4">
    <h3>Tips &amp; Tricks</h3>
    <p>
      Small bits of advice for getting the most out of ppl.
      <br />
      <a href="{{site.url}}/documentation/tips">Sound interesting?</a>
    </p>
  </div>

  <div class="span8">
    <h3>Integration Guide</h3>
    <div class="row">

      <div class="span2">
        <ul class="nav nav-pills nav-stacked">
          <li><a href="{{site.url}}/documentation/integration/bash">Bash</a></li>
        </ul>
      </div>

      <div class="span2">
        <ul class="nav nav-pills nav-stacked">
          <li><a href="{{site.url}}/documentation/integration/google">Google</a></li>
        </ul>
      </div>

      <div class="span2">
        <ul class="nav nav-pills nav-stacked">
          <li><a href="{{site.url}}/documentation/integration/mutt">Mutt</a></li>
        </ul>
      </div>

      <div class="span2">
        <ul class="nav nav-pills nav-stacked">
          <li><a href="{{site.url}}/documentation/integration/zsh">ZSH</a></li>
        </ul>
      </div>

    </div>
  </div>

</div>

<div class="row">

  <div class="span4">
    <h3>About ppl</h3>
    <p>
      Wondering why ppl even exists? Whose idea it was?
      <br />
      <a href="{{site.url}}/documentation/about">Look no further</a>
    </p>
  </div>

  <div class="span8">
    <h3>Configuration Guide</h3>
    <div class="row">

      <div class="span2">
        <ul class="nav nav-pills nav-stacked">
          <li><a href="{{site.url}}/documentation/configuration/address_book">[address&nbsp;book]</a></li>
          <li><a href="{{site.url}}/documentation/configuration/alias">[alias]</a></li>
          <li><a href="{{site.url}}/documentation/configuration/color">[color]</a></li>
          <li><a href="{{site.url}}/documentation/configuration/color_age">[color "age"]</a></li>
        </ul>
      </div>

      <div class="span2">
        <ul class="nav nav-pills nav-stacked">
          <li><a href="{{site.url}}/documentation/configuration/color_bday">[color "bday"]</a></li>
          <li><a href="{{site.url}}/documentation/configuration/color_email">[color "email"]</a></li>
          <li><a href="{{site.url}}/documentation/configuration/color_ls">[color "ls"]</a></li>
          <li><a href="{{site.url}}/documentation/configuration/color_name">[color "name"]</a></li>
        </ul>
      </div>

      <div class="span2">
        <ul class="nav nav-pills nav-stacked">
          <li><a href="{{site.url}}/documentation/configuration/color_nick">[color "nick"]</a></li>
          <li><a href="{{site.url}}/documentation/configuration/color_org">[color "org"]</a></li>
          <li><a href="{{site.url}}/documentation/configuration/color_phone">[color&nbsp;"phone"]</a></li>
          <li><a href="{{site.url}}/documentation/configuration/color_post">[color "post"]</a></li>
        </ul>
      </div>

      <div class="span2">
        <ul class="nav nav-pills nav-stacked">
          <li><a href="{{site.url}}/documentation/configuration/color_url">[color "url"]</a></li>
        </ul>
      </div>

    </div>
  </div>

</div>