bash-tutor/bash-tutor.sh

187 lines
6 KiB
Bash
Raw Normal View History

2016-06-21 03:09:40 +00:00
#!/bin/bash
# First, we'll define some paths to programs that we'll need. This is good
# practice for security and it also arguably keeps the script clean
ECHO="echo -e"
2016-06-21 03:09:40 +00:00
LS="/usr/bin/ls --color=auto"
SLEEP=/usr/bin/sleep
2016-06-21 03:09:40 +00:00
# Next, we'll simplify the mini-quizzes by wrapping them in a function. The
# idea behind this is to provide a safe environment for the learner to run
# commands in, while still feeling like a bash shell.
function test_command
{
2016-06-21 03:09:40 +00:00
while true; do
read -p "$TUTOR_PROMPT" command
case $command in
"$1") $2; break;;
*) $ECHO "Hmm, that didn't quite look right. Try typing '$1' and pressing Enter"
2016-06-21 03:09:40 +00:00
esac
done
}
function save_progress
{
cat <<EOF > ~/.bash_tutor_progress
USER=$1
TUTOR_PROMPT="$2"
PROGRESS=$3
EOF
}
2016-06-21 03:09:40 +00:00
cat <<EOF
______ __ ___ _ _ ______ _ _ ______ _____ ______
| _ \\ / \\ / __|| | | | |__ __|| | | ||__ __|/ _ \\| _ \\
| |_| // 0 \\ | |__ | |_| | | | | | | | | | | / \\ || |_| /
| _ < | __ | \\___ \\| _ | | | | | | | | | | | | || <
| |_| \\| | | | ___| || | | | | | | \\_/ | | | | \\_/ || |\\ \\
|_____/|_| |_| |____/|_| |_| |_| \\_____/ |_| \\_____/|_| |_|
Welcome to the interactive bash tutorial! To exit this tutorial at any \
time, press Ctrl+C. That is, press and hold the Control Key (Ctrl), and then \
press the C Key.
EOF
$SLEEP 2
2016-06-21 03:09:40 +00:00
if [[ -z $USER ]]; then
$ECHO -e "What is your name?"
2016-06-21 03:09:40 +00:00
while [[ -z $USER ]]; do
read USER
done
$ECHO "Great! Let's get started then, $USER"
2016-06-21 03:09:40 +00:00
fi
# The user's progress will be stored in a hidden file in their home directory.
# This will just store a bunch of environment variables to track their
# progress. This will be more useful as the tutorial gets longer.
TUTOR_PROMPT="$USER@bash-tutor ~ \$ "
if [[ ! -f ~/.bash_tutor_progress ]]; then
PROGRESS="1.0"
save_progress $USER "$TUTOR_PROMPT" "1.0"
2016-06-21 03:09:40 +00:00
else
source ~/.bash_tutor_progress
$ECHO "Welcome back, $USER"
2016-06-21 03:09:40 +00:00
fi
while true; do
case $PROGRESS in
"1.0")
$ECHO "First and foremost, let's get you familiar with your environemt. Bash \
2016-06-21 03:09:40 +00:00
is a type of shell, which allows you to run commands on your computer or \
server. You can think of it like a window that strips away all the fancy \
graphics and user interfaces and leads you directly to the operating system. \
The part of the shell where you type these commands for the computer or server \
is called the prompt.";
$SLEEP 2;
$ECHO "For this tutorial, your prompt will consist of your \
2016-06-21 03:09:40 +00:00
name, the '@' symbol, and the name of this tutorial (bash-tutor) followed by \
your current working directory (the folder that you are currently in) and a $ \
sign, which is a common convention in bash. The '~' symbol is short-hand for \
your home directory, which is where all of your personal folders and files \
are kept. Let's start with your first command: ls. The ls command lists the \
files and directories in the folder that you are in by default. Try running \
it now:\n";
test_command ls $LS;
$SLEEP 2;
save_progress $USER "$TUTOR_PROMPT" "1.1";
;&
"1.1")
$ECHO "\nMost commands can also take options (also known as flags) \
that modify their behavior. These options are usually preceded by a single or \
double hyphen. For example, with ls you can pass the -l flag to list more \
information on each of the files and directories. Try it now:\n";
test_command "ls -l" "$LS -l";
$SLEEP 2;
save_progress $USER "$TUTOR_PROMPT" "1.2";
;&
"1.2")
$ECHO "\nDon't worry about what all of this means right now. We'll \
cover it later. For now, you can practice some other flags. A good one to \
remember is the --help flag, which usually provides you with a list of \
options you can use. This is sometimes shortened to just -h. For now though, \
let's talk about arguments.";
$SLEEP 2;
$ECHO "Arguments are additional pieces of information that you can give to a \
command that usually changes the location of where the command is run. For \
example, running the 'ls' command as we did before lists the contents of the \
current directory we are in. If you supply ls with a file or folder on the \
system though, it will print out that file's name or that folder's contents. \
Try running 'ls' on the '/' directory.\n";
test_command "ls /" "$LS /";
save_progress $USER "$TUTOR_PROMPT" "1.3";
;&
"1.3")
$ECHO "\nWhat you're looking at is the root directory of your \
system. This is basically what holds all of the files and folders that run \
the Linux operating system. We'll go over what each folder is for in a later \
lesson.";
$SLEEP 2;
$ECHO "Being able to look at these different folder contents is nice, but \
sometimes you may need to be able to move around into different folders \
for easier access to your files. To do this, you use the 'cd' command. Try
running it now, without any options or arguments.\n";
$SLEEP 2;
test_command "cd" "cd";
$ECHO $TUTOR_PROMPT;
save_progress $USER "$TUTOR_PROMPT" "1.4";
;&
"1.4")
$SLEEP 2;
$ECHO "\nThe 'cd' command, without any arguments, brings you back to \
your home directory. Since you were already there, nothing really happened. \
Try running 'cd' on the /etc directory to see what happens then.\n";
test_command "cd /etc" "cd /etc";
2016-06-21 03:09:40 +00:00
TUTOR_PROMPT="$USER@bash-tutor /etc \$ ";
2016-06-21 03:09:40 +00:00
$ECHO $TUTOR_PROMPT;
2016-06-21 03:09:40 +00:00
$SLEEP 2;
2016-06-21 03:09:40 +00:00
save_progress $USER "$TUTOR_PROMPT" "1.5";
2016-06-21 03:09:40 +00:00
;&
2016-06-21 03:09:40 +00:00
"1.5")
$ECHO "\nYou've reached the end of the tutorial, for now. Check \
back on either the GitHub page for this project, or my personal blog at \
https://wbrawner.com/blog, where I will also be posting updates, to see if \
there is a newer version with more lessons. Thanks for testing!";
break;;
esac
done