Getting started

Build Shale

Shale builds from source with Sigil. You need Sigil 0.24.11 and a C compiler. Sigil 0.24.11 isn't released yet, so these steps won't work until it is. Until then, the source is there to read and follow along.

Get the source, then install the dependencies and build:

your shell
$ git clone https://git.usesigil.org/sigil/shale.git
$ cd shale
$ sigil deps install
$ sigil build --config release

The build writes the program to build/release/bin/shale. Copy it to a directory on your PATH, such as ~/.local/bin, so you can start it by name.

Start a session

Run shale from the shell you use now. That shell stays as it was, and typing exit, or pressing C-d on an empty line, takes you back to it.

your shell
$ shale

The first time, Shale prints a one-line welcome. Then you get the prompt: a line saying who and where you are, and a dollar sign where you type. Commands work the way you expect from Bash or fish.

shale
~/project $ ls
README.md
notes.txt
src

~/project $ grep -n plumber notes.txt
2:call the plumber

The transcripts in this manual show each command after a short prompt, like the ~/project $ lines above, to keep them compact. Your own scrollback keeps the full prompt unless you turn on the short prompt; to learn how, read The prompt.

Ask Sigil a question

A line that starts with ( is Sigil. Shale runs it without printing its value, and anything you define stays defined for the rest of the session. To see a value, start the line with a comma instead:

shale
~/project $ (define greeting "hello from Sigil")

~/project $ ,(string-upcase greeting)
"HELLO FROM SIGIL"

~/project $ echo ,greeting
hello from Sigil

A comma puts a Sigil value into a command line. That's most of what's different about Shale. To learn the rest, read Commands and Sigil.

Where to go next

  • The prompt explains the heading, the short prompt and the result line Shale prints when a command fails.

  • Editing a command line covers the keys, history search and suggestions.

  • Configuration shows how to add your own commands and abbreviations.