all versions |
This is the home page for version 0.8.1 of Oil, a Unix shell. To use it,
- Download a source tarball.
- Build and install it, as described in INSTALL.
These steps take 30 to 60 seconds on most machines. After that, you can
oshrc file, which is described in the
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. It's work in progress, but these
docs are ready:
Help topics for OSH and
Oil. These documents underly the
Github Wiki for oilshell/oil. The Oil
Deployments wiki page
has other ways of getting Oil. These versions may not be up-to-date.
Main Test Suites
- Spec Tests
- 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
- OPy. How much code is in the OPy
- 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.
oil-native. The future of Oil is pure native code.
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.
The OPy compiler is used to compile Oil to bytecode, but isn't itself part of
Generated on Mon Sep 28 00:26:23 PDT 2020