Warning: Work in progress! Leave feedback on Zulip or Github if you'd like this doc to be updated.

All Docs

Oils is our upgrade path from bash to a better language and runtime. This page links to all the documentation.

Table of Contents
Preliminaries
Reference
Interactive Shell
OSH is a Compatible Shell
YSH is a Shell with Structured Data
Comparisons
Design Concepts
Data Languages Avoid Ad-Hoc Parsing
The Shared Oils Runtime
For Contributors
More

† means a doc is not ready to read yet.

Preliminaries

Reference

Like many other docs, the reference is still in progress:

Interactive Shell

OSH is a Compatible Shell

These docs are for advanced users:

YSH is a Shell with Structured Data

Comparisons

Design Concepts

YSH has 3 main sublanguages:

Crosscutting design issues:

Data Languages Avoid Ad-Hoc Parsing

YSH programs "talk about" these data languages, also called interchange formats or protocols. In-memory data structures are in service of data languages on the wire, not the other way around.

TODO:

The Shared Oils Runtime

Internal details:

For Contributors

Internal Architecture:

More


Generated on Sun, 04 Feb 2024 00:32:22 -0500