Why Sponsor Oils? | source | all docs for version 0.26.0 | all versions | oils.pub

Published Docs

This page links to docs that are ready to read.

See All Docs for links to drafts.

Good Places to Start

• Getting Started
• A Tour of YSH
• YSH vs. Shell Idioms
• Oils Reference - underlies the help builtin
• FAQ on Docs. Look here if you can't find something.

Build/packaging:

• INSTALL. How do I install Oils? This text file is also in the oils-for-unix tarball.
  • Oils Build --help Mirror
  • Portability

More

OSH:

• Known Differences Between OSH and Other Shells | Quirks | Headless Mode | Shell Idioms

YSH:

• A Feel For YSH Syntax | YSH Style Guide | What Breaks When You Upgrade to YSH | YSH Language FAQ

• Comparisons: YSH vs. Shell | YSH Expressions vs. Python

• Features: Egg Expressions (YSH Regexes) | YSH Regex API | Guide to YSH Error Handling | Guide to Procs and Funcs | YSH Fixes Shell's Error Handling | Simple Word Evaluation | Variable Declaration, Mutation, and Scope | Hay - Custom Languages for Unix Systems

Data Languages:

• JSON | J8 Notation | BYO Protocols

Language Design:

• Syntactic Concepts | Command vs. Expression Mode | Language Influences
  • Notes: Novelties in OSH and YSH | Warts

The Shared Oils Runtime

• Types in the Oils Runtime | Tracing Execution

Reference:

• Oils Error Catalog, With Hints

For contributors:

• ul-table: Markdown Tables Without New Syntax