Skip to content
Jason Frey edited this page Aug 24, 2018 · 6 revisions

Welcome to the Optimist Documentation and Examples wiki!

Basic Example - The basic example from the original Optimist documentation with some additional commentary.

Medium Example - A more comprehensive example and a few variations on it. Also a discussion of dependencies/conflicts and Optimist::die.

Commands - An example using commands, in a manner similar to git, that each have separate options and help.

Banner, Synopsis and Version - Ways to decorate your help message and provide version information.

Option Types - Discusses how to assign types to options.

Controlling Short Options - Optimist auto-generates short-options. What you need to know about this behavior and how to wrangle it.