This project has been created as part of the 42 curriculum by lchamard and yben-dje.

Ghibli Shell

Description

You like Ghibli? You like Bash? If this is the case for you (I hope), this project is made for you! This project is a partial remake of bash bringing Ghibli magic to your terminal ✨.

Module names (Warning spoil)

We gived the name of Ghibli's characters to the project's modules.

Module	Name	Why?
TTY	Arietty	Her name contains "TTY".
Tokeniser	Shizuku	She is a raw stone waiting to be polished.
Parser	Haru	The story is the polished stone.
Executor	Miyazaki	He is the movie director.
Expander	Ponyo	She reconciles and merge the humans' world and the sea.
Error manager	Ursula	She's an artist.
Built-in	Sheeta	The levitation stone is magic like the built-in commands.
File runner	Jiro	He creates planes.
Env variable manager	Totoro	Because he cares about the Environment.
Signals handler	Umi	She can send messages with flags.
Allocator	Marnie

Open a discussion thread if you want more info about the choices.

Instructions

Build

To build the project, you can run this command

make

Recompile the project with

make re

If you don't want the animations or you want the debug compiler flag, run this command

DEBUG=please make

Recompile the project with

DEBUG=please make re

Execute

To execute Ghiblishell, run

./minishell

You can also run scripts from a file (usualy .gsh files).

./minishell my_script.gsh

This will execute the file line by line until minishell encounters an error or reach the end of the file. Exit the shell with the exit command.

Additional features

• You can edit the environment variables such as the PROMPT variable in the ~/.ghiblirc gsh file.
• The prompt is displayed using the PROMPT environment variable. You can modify the variable to change the prompt.
• The shell supports source.
• The built-in echo supports escapes.
• Simply executing export will display the list of all variables.
• The SHLVL is supported.
• You can add conditions and expands in the prompt line.
• The syntax checker shows you were you made an error.

Arrietty's prompt line:

You can add conditions with %ftext; and !ftext; where f is a flag. Currently, Ghiblishell supports %h and !h to check if the user is under its home directory and %s/!s to check if the latest command returned 0. @ is for "if" and ! is for if not. It also supports custom expands with @e where e is the data's name. Currently, you can use @u to get the username, @l to get the location, @s to get the last command's return code, @r to get the PWD relative to HOME, @1 to start an ansi escape sequence and @2 to stop an ansi escape sequence. You can combine the two features.

Here is the default prompt line:

export PROMPT='@1[1;35m@2GhibliShell@1[0m@2 @u\@%h@1[1\;33m@2~@1[0m@2@1[36m@2@r@1[0m@2;!h@1[36m@2@l@1[0m@2; @1[1m@2%s@1[32m@2>@1[0m@2;!s@1[31m@2X@1[0m@2;@1[22m@2 '

But you can also try this one:

export PROMPT="@1[46;35;1m@2GSh@1[38;5;21m@2 @u@1[38;5;214m@2\@@1[22m@2@1[35m@2%h🏠@1[30m@2@r;!h@1[30m@2@l; %s@1[38\;5\;22m@2✔@1[39m@2;!s@1[91m@2✘➙@s@1[39m@2; @1[0m@2@1[36m@2🭬@1[0m"

The prompt line also have support for some escapes including \e and ansii escape sequences using @1 and @2.

Resources

We mainly used the man of the commands for documentation. The ascii arts animations are made by yben-dje.

The Little Totoro dot art is from emojicombos.com.

The catbus dot arts was made by yben-dje using a mix of image processing, automated tools and manual drawing. The frames are directly based of the film.

We used an online tutorial about signals.

What? You just said I-I ? Oh no, "AI"? I don't know what that means. Well... ok... I do know what "AI" is. BUT DO YOU KNOW WHO YOU'RE TALKING TO? GET OUT OF THERE! WE DO NOT USE AI HERE! USING AI IS A SKILL ISSUE AND WE ARE GIGA CHADS. SO STOP TALKING TO US ABOUT AI!

Hum... How are you today 🤗?

Go watch Ghibli films now!