all versions |
This is the home page for version 0.9.4 of Oil, a Unix shell. To use it,
- Download a source tarball.
- Build it and do a "smoke test", as described in INSTALL.
These steps take 30 to 60 seconds on most machines. After installation, see
Test results, metrics, and benchmarks are shown below.
||File / SHA256 checksum
oil-native is a preview release, not a working shell.
The Doc Overview links to all docs. Here is the subset of them that
are ready to read:
- Getting Started
- The Oil language:
- Language Design:
- Interchange Formats:
Main Test Suites
- Spec Tests
- OSH Survey. Test OSH with existing
shells, and compare their behavior.
- OSH in C++. The progress of Oil's
- Oil Language. The legacy-free
- Wild Tests. Parse and translate thousands of shell scripts
- Unit Tests. Python unit test results.
- [ ] Test build and install on OS X
- Parser. How fast does OSH
parse compared to other shells?
- Runtime. How fast does OSH run shell
- Compute. How fast does OSH run small programs
- Build. How long does it take for end users to
build Oil? How big is the resulting binary?
- Virtual Memory Baseline. How much memory do
shells use at startup?
- mycpp. Compares Python and generated C++
on small examples.
- Lines of source, counted in different ways:
- osh-cloc. OSH and common
libraries, as measured by the cloc tool.
- src. The whole Oil repo organized by
type of source file.
- oil-cpp. The C++ code in the
These files may help you understand how Oil is implemented, i.e. with
domain-specific languages and code generation.
- _devbuild/gen/id.h. A list of language
elements, used in the lexer and in multiple parsers and evaluators.
- The regex-based lexer uses two stages of code generation:
- frontend/syntax.asdl. The syntax tree
for OSH and Oil.
- oil_lang/grammar.pgen2. The
expression grammar for Oil. In contrast, the OSH parsers are hand-written.
Also see the oilshell/oil repository.
Old / Experimental
These links describe the CPython / "OVM" build, which should become
the "experimental" version of Oil.
The OPy compiler is used to compile Oil to bytecode, but isn't itself part of
OPy / OVM Metrics
- OPy Line Counts.
- Lines of dependencies:
- pydeps. Oil code plus the Python
- nativedeps. Oil code plus a
slice of CPython.
- Bytecode Metrics
- OVM / CPython
- overview - An analysis of GCC's
compilation of OVM (a subset of CPython). Bloaty provides the
- cpython-defs/overview - We try to
ship as little of CPython as possible, and this is what's left.
Generated on Thu Nov 18 14:34:34 EST 2021