Shell

From Coder Merlin
Within these castle walls be forged Mavens of Computer Science ...
— Merlin, The Coder

Prerequisites[edit]

The Client and the Server[edit]

Client-server-model

A client-server model is a means of distributing resources between the provider of a service and a consumer of that service, the client. You're likely very familiar with this concept though less familiar with the name. One common example of a service provided in this manner is email. You, a user, can open an email client (for example, an app on your iPhone or Outlook on a PC) which then connects to a remote server. The server is responsible for providing several services, including receiving mail on your behalf from other servers, transmitting email on your behalf to others, and storing your email for your later use.

ObserveObserveIcon.png
Observe, Ponder, and Journal: : Section 1
  1. Name at least two other services that you personally use which are implemented using a Client/Server Model

There are several advantages to this model:

  • Users don't need to personally possess the hardware required to fulfill a particular service, only a means of connecting and communicating with a server which provides the service
  • Users don't need to worry about installing and configuring the server hardware
  • Users are able to access their data from anywhere in the world (as long as they have internet access)
  • The state of a users data remains consistent, regardless of how and from where they access the server

Merlin is built upon this Client/Server Model, so you won't need any particular type of hardware or software, only a device capable of running a web-browser and a terminal emulator (available in Google Chrome).

First Connection[edit]

Coder Merlin is a cloud-based server where we’ll be doing most of our exercises. To access Merlin, you’ll need a secure shell client.

If you’re using a Mac or a Linux based device you’ll probably have a built-in client that you can access from the terminal.

If you’re using a Windows-based device, you can access a terminal by installing Google Chrome, and then within Google Chrome typing “Secure Shell Extension” and then installing the extension.

Either way, you’ll need a connection string to access the server. The connection string will begin with your first name and last name separated by a hyphen, for example: john-williams. The rest of the connection string will be @ssh.codermerlin.com

For John Williams, the entire connection string would be:

 john-williams@ssh.codermerlin.com

After you’re connected, you’ll be prompted to enter your password. After a successful logon, you'll land in the "shell".

The Shell[edit]

A shell is a user interface which provides access to an operating system’s services. There are two basic types of shells: a “command-line interface” (CLI) and a “graphical user interface” (GUI). You are likely familiar with common GUI’s from Microsoft Windows and perhaps Apple’s macOS. This document will focus on a CLI known as bash, a shell for the Unix operating system by Brian Fox. The shell is an acronym for Bourne-again shell, named for the Bourne shell that it replaces. Login to the Merlin Server as discussed previously. After some introductory text, you’ll see a prompt which will look something like this:

john-williams@codermerlin:~$ 

You’ll see your login name, an at (@) sign, the name of the server (“codermerlin”), a colon (:), a tilde (~), and a $. This will be followed by a flashing block called a cursor. The cursor indicates where new characters will appear as you type. The cursor will continue to flash patiently as it awaits input. We’ll get back to the meaning of the tilde soon.

We'll be using a server running Linux, a Unix-like operating system. Almost everything in Unix is either a file or a process. A file is either a destination or source for a stream of data. A process is a program that is being executed by the operating system. While printers and screens are considered to be “files” in Unix, a more general way of thinking of files is a collection of data that can be referred to by name. Files can be created by users directly (for example, via a text editor) or indirectly, such as the result of running a program like a compiler.

Linux File Hierarchy

All files are integrated into a single, hierarchical directory structure that appears as an inverted tree. A directory provides a logical grouping of related files. The top of this tree is called the root and is referred to by a slash (/). In the diagram, we see that the root contains five subdirectories (i.e., a directory below the parent directory): bin, etc, home, lib, and tmp. The home directory contains two subdirectories, jack-williams and john-williams. Note that this differs from a Windows file structure as Unix integrates all files into a single directory structure rather than listing different physical storage devices. Thus, the file structure is logical rather than physical. A path describes an ordered transition through one or more directories on the way to a destination (either a directory or a file). As such, note that while both jack-williams and john-williams each have a subdirectory named "projects" these are different directories. The path to the former is "/home/jack-williams/projects" while the path to the latter is "/home/john-williams/projects". Paths which begin at the root (symbolized by the initial slash) are called absolute paths. All other paths are relative paths.

ObserveObserveIcon.png
Observe, Ponder, and Journal: : Section 2
  1. It appears that both Jack Williams and John Williams can have a directory of the same name. Do you think the ability to have two different users create a directory of the same name is important? Why?

Print Working Directory[edit]

The shell uses a concept known as your working directory, which can be thought of as your current directory, i.e. where you are currently located in the file system. If you forget where you are, you can always use the command pwd to print the working directory. Try it now. Type “pwd” followed by <RETURN>. Note that you’ll need to press <RETURN> after any command before the shell will execute the command.

john-williams@codermerlin:~$  pwd

/home/john-williams 

The command will print something similar to “/home/john-williams” and then present you with a new prompt and cursor to indicate that it’s ready and awaiting your input. This directory is your home directory and it has a special symbol, the tilde (~).

ObserveObserveIcon.png
Observe, Ponder, and Journal: : Section 3
  1. Why do you think the home directory has a special symbol to represent it?

Make a New Directory[edit]

In order to keep our Merlin Missions organized, let’s place them all under a directory named “Merlin”. To make a new directory, we’ll use the command mkdir to which we’ll provide a single argument, the name of the directory that we want to create. Try it now. Type “mkdir Merlin” followed by <RETURN>.

john-williams@codermerlin:~$  mkdir Merlin

List the Contents of a Directory[edit]

How do we find out what’s contained in our current directory? We can use the ls (that’s a lowercase ‘L’ followed by a lowercase ’S’) command to list the directory contents. Try it now. Type “ls” followed by return.

john-williams@codermerlin:~$  ls

The command will print the contents of the current directory (in this case our home directory) which will include the single directory, “Merlin”, that we created earlier.

Change to a New Directory[edit]

When we want to change our current directory we use the cd command followed by the name of the directory to which we want to change. Try it now. Type “cd Merlin”.

john-williams@codermerlin:~$  cd Merlin

john-williams@codermerlin:~/Merlin$  


ObserveObserveIcon.png
Observe, Ponder, and Journal: : Section 4
  1. Did the prompt change? If so, how? Why is this useful?

Note that our prompt has now changed. Before the command was executed, the prompt contained a single tilde indicating that our home directory was our current directory. After executing the command our prompt now includes a tilde, followed by a slash, followed by “Merlin”. This indicates that we are in the directory named “Merlin” below our home directory. The slash is a delimiter separating the levels of our hierarchy.

Let’s try the pwd command again.

john-williams@codermerlin:~/Merlin$  pwd

We can now see that from the root, we’re three levels down:
/ (root)
home
john-williams
Merlin

The cd command has a useful shortcut. If we type the command without an argument, it will take us back to our home directory. It’s the equivalent of "cd ~". Let’s try it now:

john-williams@codermerlin:~/Merlin$  cd

john-williams@codermerlin:~$  

Now, move back to the Merlin directory by issuing the appropriate command.

Change to a New Directory, but Temporarily[edit]

When we want to change our current directory temporarily (meaning we want to return later to where we are now), we use the pushd command followed by the name of the directory to which we want to change. Try it now. Type “pushd Merlin”.

john-williams@codermerlin:~$  pushd Merlin

john-williams@codermerlin:~/Merlin$  

We can now perform any actions we'd like in this directory and when we're done, we can easily return from whence we came without needing to type in the original directory name. The popd command will look up where we came (when we used pushd) and return us to there. Try it now. Type popd.

john-williams@codermerlin:~/Merlin$  popd

john-williams@codermerlin:~$  

Tab Completion[edit]

Very often, the shell can help us to complete file and directory names when we begin to type the name of a file (or directory) and then type TAB. Try it now. Type "cd M" and then press TAB. The shell will complete the rest of the name by appending "erlin" to what you’ve already typed. Then press ENTER. Because the completion is not ambiguous (i.e. there is only one solution) the shell will complete the name. If there were multiple possibilities, the shell would complete as much as possible and then beep. At this point, we could press TAB twice in succession to see the possible completions. Let’s try this. Within the Merlin directory, create three new directories: hello, hello2, and hello3:

john-williams@codermerlin:~/Merlin$  mkdir hello

john-williams@codermerlin:~/Merlin$  mkdir hello2

john-williams@codermerlin:~/Merlin$  mkdir hello3

Then, type “cd h”:

john-williams@codermerlin:~/Merlin$  cd h

Now, press TAB. The shell will complete as much of the name as possible and then beep. (Depending on your terminal you may not hear the beep or you may see a flash.)

john-williams@codermerlin:~/Merlin$  cd hello

Now press TAB twice in succession. The shell will display matching possibilities and then provide a new prompt followed by the previous entry:

hello/ hello2/ hello3/ 

john-williams@codermerlin:~/Merlin$  cd hello

You now have the option of pressing ENTER to accept "hello" or adding some more characters (in this case “2” to form “hello2” or “3” to form “hello3”) and then pressing ENTER to execute the command as-is or TAB to search for additional completions. In our case, let’s press ENTER to descend into the "hello" directory:

john-williams@codermerlin:~/Merlin$  cd hello

john-williams@codermerlin:~/Merlin/hello$  

echo[edit]

The echo command echoes the argument to the output. Let’s try it. Type: echo "Hello, World!" The echo command dutifully echoes the argument to the screen.

john-williams@codermerlin:~/Merlin/hello$  echo "Hello, World!"

Hello, World! 

Redirection[edit]

Remember that we said that almost everything in Unix is either a file or a process and that the screen could be considered as a file. We can redirect the output from echo to another file, one that we'll store in the file system. We do this with with the > (greater-than) symbol. Normally, commands will send their output to a device called stdout. This is what the echo command did when we used it earlier. In our case, stdout is printed to our terminal. Let’s try to redirect our output to a file. Type: echo "Hello, World!" > out.txt:

john-williams@codermerlin:~/Merlin/hello$  echo "Hello, World!" > out.txt


ObserveObserveIcon.png
Observe, Ponder, and Journal: : Section 5
  1. Was "Hello, World!" printed to the screen as before? If not, why not? What do you think happened to the text?


No output was displayed; we just received a new prompt. Let’s use the ls command to take a look:

john-williams@codermerlin:~/Merlin/hello$  ls

out.txt 

We can see that the directory contains a single file, "out.txt" which was created by the echo command. How can we see what's contained within this file?

Quickly View File Contents[edit]

To quickly view the contents of a file we can use the cat command. The cat command concatenates files together and then sends the output to stdout. (Remember that in our case this is the screen.) Let’s try it. Type "cat out.txt".

john-williams@codermerlin:~/Merlin/hello$  cat out.txt

Hello, World! 

Let’s move back up to our home directory. Remember that we can do this by typing "cd" without any arguments.

john-williams@codermerlin:~/Merlin/hello$  cd

john-williams@codermerlin:~$  

tree[edit]

Sometimes it’s helpful to obtain an overview of our directory hierarchy. We can do this with the tree command. Let's try:

john-williams@codermerlin:~$  tree

.

└─ Merlin

   ├─ hello

   │  └─ out.txt

   ├─ hello2

   └─ hello3

ObserveObserveIcon.png
Observe, Ponder, and Journal: : Section 6
  1. How does the ls command differ from the tree command?
  2. How do you choose to use one over the other?

Clear the Screen[edit]

In some cases it’s useful to clear the screen. (For example, this might be useful if you sense your guide creeping up behind you when you were doing something that you weren’t supposed to be doing. 😁) We can do this with the clear command. Type clear and then press RETURN.

john-williams@codermerlin:~$  clear

rmdir[edit]

Let's remove the two directories that we won't be using anymore. We can do this with the rmdir command. Move to the Merlin directory and then remove the hello2 and hello3 directories. Then do a directory listing to see what’s left.

john-williams@codermerlin:~$  cd Merlin

john-williams@codermerlin:~/Merlin$  rmdir hello2

john-williams@codermerlin:~/Merlin$  rmdir hello3

john-williams@codermerlin:~/Merlin$  ls

hello 

Display a Manual[edit]

Finally, let's try out one more very helpful command. If we want to learn more about a command we can read its manual. We do this with the command man. As an example, look at the man page for the emacs command. Type man emacs.

john-williams@codermerlin:~/Merlin$  man emacs

The screen will be filled with information about the emacs command. While a man page is displayed we can use the following keys to navigate:

  • f Typing the f key will move us forward one page in the manual
  • b Typing the b key will move us backward one page in the manual
  • q Typing the q key will quit (exit the manual)

Exit the manual now.

Exiting the Shell[edit]

In general, there's no need to exit the shell. It's almost always sufficient to close your terminal emulator. An advantage to this approach is that the next time you connect to the server you'll be in exactly the same place where you left off. However, on rare occasions the terminal emulator can become "confused" and display characters in odd places. In such a case, there's still no need to exit; instead, use the reset command.

References[edit]