Getting started

Usage

Download your project's documentation, then browse it in your terminal.

Sync your documentation

Go into any Ruby project with a Gemfile.lock and run:

posh sync

This downloads the available documentation for your project’s Ruby and gem versions to your machine. Run it again after changing dependencies, or enable automatic sync with Bundler.

Open the browser

From inside your project, run:

posh

POSH opens a terminal interface for browsing your project’s documentation. The documentation browser is free, with no limits.

Clear downloaded documentation

To remove all docsets from your machine, run:

posh clear