closh - Bash-like shell based on Clojure

Closh combines the best of traditional unix shells with the power of Clojure. It aims to be a modern alternative to bash.

Demo showing how to execute commands and using Clojure to manipulate outputs in shell:

Why try to reinvent bash?

• Bash has obscure syntax for non-trivial operations and lots of WTF moments.
• It treats everything as text while we mostly need to manipulate structured information.
• It is a large codebase which makes it difficult to hack on it and try innovative ideas. Which is one of the reasons why the shell did not improve much in recent decades.

Why shell based on Clojure(Script)?

• Clojure's has a simple syntax and well-thought design which makes it pleasurable to work with.
• Its extensive collection of powerful functions for data manipulation is suitable to provide solutions for daily tasks.
• Write shell scripts in a language you use daily for development so you don't have to google arcane shell constructs every time you need to do anything but simplest tasks.
• Less amount and more composable code allows to experiment with new features and ideas.

Warning: Closh is still in a early stage and under a heavy development. It is not ready for daily use yet since it is quite easy to get it to crash. At this moment I am most interested in gathering feedback and use cases to help make the best possible design trade-offs. Closh is tested on Linux, should run on macOS too. Windows who knows.

Community and Contribution

If you have feedback about a specific feature feel free to open an issue.
For general discussion you can use gitter chat.

If you would like to contribute take look at open issues. Leave a comment if you find anything interesting and we can improve the project together.

Quick Start

Install closh (requires node.js):

npm install -g lumo-cljs closh

To install development version from master branch:

npm i -g dundalek/closh

Start the shell:

closh

Run simple commands like you are used to:

$ echo hi

$ git status

$ ls -l *.json

Commands starting with a parenthesis are evaluated as Clojure code:

$ (+ 1 2)
; => 3

The power comes from combining shell commands and Clojure:

$ echo hi | (clojure.string/upper-case)
; => HI

$ ls *.json |> (reverse)

; Count number of files grouped by first letter sorted by highest count first
$ ls |> (group-by first) | (map #(update % 1 count)) | (sort-by second) | (reverse)

Documentation

• Guide and Reference
• Design Principles
• Notes on Existing Shells

Roadmap

Stage 1

Initial proof-of-concept, try out if the combination of shell and Clojure could work. [COMPLETED]

• Command execution
• Pipes
• IO Redirects
• Interactive mode REPL

Stage 2

Implement essential functionality needed for daily use by early adopters. [IN PROGRESS]

• Dynamic prompt
• Persistent history
• Tab-completion
• Signal control
• Job control
• Improved reader
• Configuration
  • Loads ~/.closhrc on startup
  • Aliases
  • Load files and libraries

Stage 3

Add additional features users expect from a shell. Then fix bugs and stabilize through continuous daily use.

• Key bindings
• Handle common errors
• Environment variable integration
• Builtin utility functions
• Testing and stability

Stage 4

At this point we can start to experiment with innovative ideas and paradigms. For example:

• Syntax highlighting
• Automatic abbreviation suggestion
• Automatically generate autocompletions for unknown / custom programs
• Interactive command-line interfaces
• Data helpers that automatically parse command output into data structures
• Structured output ala TermKit or lisp machines

Tech details

Closh runs ClojureSript on node.js via lumo REPL. In order to be somewhat bashward compatible there is a command mode which transforms top-level forms in a macro-like way.

Thanks to Clojure's syntax for symbols supporting almost all characters we don't need to roll out a custom parser to support convenient unquoted notation for filenames and switches. Only customization done to a built-in reader is the support multiple slashes in a symbol, which is required for nested directories.

Development

Clone the repo and install dependencies

git clone [email protected]:dundalek/closh.git
cd closh
npm install
npm install -g lumo-cljs

Run the app

npm start

Run in dev mode reloading on changes

npm run dev

Run tests once

lein test

Re-run tests on change

lein test-auto

Generate API documentation into doc/api

lein doc

Copyright & License

Copyright (c) Jakub Dundalek and contributors

Distributed under the Eclipse Public License 1.0.