Shell scripting · Lesson 28 of 31 · 8 minutes

Predictable output contract

Create machine-readable status lines and verify their shape.

Open the lab Course map

Mastery 0/3Run itExplain itApply it

learner@clairos:~ $

↑ history · Tab complete · Ctrl+C cancel · Esc, Tab to leaveExit 0

Your objectives

Hints are always available. Wrong turns never cost XP.

1
Write a status line
Run printf status=ready | tee lab/status.env.
Hint & worked example
Format data deliberately, including separators and final newlines. Copy a stream both to a file and standard output; -a appends.
The command outcome must match the task, including successful access or the explicitly requested failure.
```
printf status=ready | tee lab/status.env
```
Remember: A format string controls output; a newline is data, not an automatic guarantee. tee can overwrite a file even though the output is also visible on screen.
2
Verify the status key
Run grep status lab/status.env.
Hint & worked example
Select input lines that match a pattern; -i ignores case, -n adds line numbers, and -v inverts selection.
The command outcome must match the task, including successful access or the explicitly requested failure.
```
grep status lab/status.env
```
Remember: No matches is exit status 1, which is different from a malformed invocation.
3
Read the output contract
Run cat lab/status.env.
Hint & worked example
Read one or more files to standard output without editing their contents.
The command outcome must match the task, including successful access or the explicitly requested failure.
```
cat lab/status.env
```
Remember: Reading a source file should precede changing it; avoid printing real secrets.

Understand the pattern

Producing predictable script-style status output helps operators explain what they know before they change anything.

printf: Format data deliberately, including separators and final newlines.
A format string controls output; a newline is data, not an automatic guarantee.
tee: Copy a stream both to a file and standard output; -a appends.
tee can overwrite a file even though the output is also visible on screen.
grep: Select input lines that match a pattern; -i ignores case, -n adds line numbers, and -v inverts selection.
No matches is exit status 1, which is different from a malformed invocation.
cat: Read one or more files to standard output without editing their contents.
Reading a source file should precede changing it; avoid printing real secrets.

Worked example and expected result

$ printf status=ready | tee lab/status.env

status=ready

Exit status: 0. The command completed successfully in the training fixture.

$ grep status lab/status.env

status=ready

Exit status: 0. The command completed successfully in the training fixture.

$ cat lab/status.env

status=ready

Exit status: 0. The command completed successfully in the training fixture.

Try a variation

Repeat this workflow in the sandbox with a different scratch filename. Keep the system fixtures unchanged and compare the observed output with your expectation before moving on.

Explain it

In “Predictable output contract”, which interpretation is safe?A successful first check guarantees that every dependent service is healthy.No matches is exit status 1, which is different from a malformed invocation.A command appearing in history proves it completed successfully.

Apply it elsewhere

Before adapting the grep workflow from “Predictable output contract” to another server, what should you do?Confirm the current directory, target identity, permissions, and the installed command behavior first.Paste the training paths unchanged into production.Skip output inspection whenever the command is familiar.

Keep the momentum.

Complete the lab, then explain and apply the pattern.

Next: Script path resolution Try an incident drill

Anonymous lesson and mastery progress lasts for this session. Sign in to keep synced lesson XP between sessions; mastery stays device-local. No speed bonus, lost lives, or hint penalties.

Keep learning

GNU Coreutils manual · GNU Bash manual