oils-for-unix/oils: Oils is our upgrade path from bash to a better language and runtime. It's also for Python and JavaScript users who avoid shell!

Oils Source Code ================

[Oils][home-page] is our upgrade path from bash to a better language and runtime!

• [OSH][] runs your existing shell scripts.
• [YSH][] is for Python and JavaScript users who avoid shell.

[OSH]: https://oils.pub/cross-ref.html#OSH [YSH]: https://oils.pub/cross-ref.html#YSH

[rename]: https://www.oilshell.org/blog/2023/03/rename.html

[Oils 2023 FAQ][faq-2023] / [Why Create a New Unix Shell?][why]

[faq-2023]: https://www.oilshell.org/blog/2023/03/faq.html [why]: https://www.oilshell.org/blog/2021/01/why-a-new-shell.html

It's written in Python, so the code is short and easy to change. But we translate it to C++ with custom tools, to make it fast and small. The deployed executable doesn't depend on Python.

This README is at the root of the [git repo][git-repo].

Important: If you want to use Oils, don't clone this repo. Instead, visit . See the wiki: The Oils Repo Is Different From the Tarball Releases.

[git-repo]: https://github.com/oils-for-unix/oils

Contributing

• Try making the dev build of Oils with the instructions on the

• If it doesn't, let us know. You can post on the #oils-dev channel of

• Feel free to grab an issue from

[Contributing]: https://github.com/oils-for-unix/oils/wiki/Contributing [oilshell.zulipchat.com]: https://oilshell.zulipchat.com/ [blog]: https://oils.pub/blog/

Dev Build

After following those instructions, you should have a Python program that you can quickly run and change! Try it interactively:

bash$ bin/osh

osh$ name=world osh$ echo "hello $name" hello world

• Try running a shell script you wrote with bin/osh myscript.sh.
• Try [YSH][] with bin/ysh.

Remember that this is the dev build in Python, not a released binary. The Oils Repo Is Different From the Tarball Releases.

Important: We Accept Small Contributions!

Oils is full of many ideas, which may be intimidating at first.

But the bar to contribution is very low. It's basically a medium size Python program with many tests, and many programmers know how to change such programs. It's great for prototyping.

• For OSH compatibility, I often merge **failing spec

• You only have to make your code work in Python. Plain Python programs

• You can influence the design of [YSH][]. If you have an itch to

I aim for 24 hour response time

Please feel free to ping andychu on Zulip or Github if you're waiting for a pull request review! (or to ask questions)

Usually I can respond in 24 hours. I might be traveling, in which case I'll respond with something like I hope to look at this by Tuesday.

I might have also missed your Github message, so it doesn't hurt to ping me.

Thank you for the contributions!

Docs

The Wiki has many developer docs. Feel free to edit them. If you make a major change, let us know on Zulip!

If you're confused, the best thing to do is to ask on Zulip and someone should produce a pointer and/or improve the docs.

Docs for end users are linked from each release page.

Links

• The [Oils Home Page][home-page] has all the important links.
• Related:

[repo-overview]: doc/repo-overview.md

[repo-tarball-faq]: https://github.com/oils-for-unix/oils/wiki/The-Oils-Repo-Is-Different-From-the-Tarball-Releases