Here’s a pre-configured, ready-to-use set of command line tools for technical writers. It’s ready to install and use on Windows, macOS, Linux, or almost any other platform that can run a Docker container.
What’s in the box
Or, more accurately, here’s what’s in the container:
- GNU Bash command line shell
- GNU Nano text editor
- GNU Core utils for searching, slicing, and dicing text
- GNU AWK for processing lines of text
- Man pages for built-in documentation
Installing
- Install Docker Desktop.
- That’s it.
Starting Tech Writer Tools
Launch the Docker Desktop application.
Open a terminal application:
- Linux: Press the Meta/Windows key, search for terminal.
- macOS: Press Command-Space, search for terminal.
- Windows: Press the Windows key, search for terminal.
In the command line, enter this command:
docker run -it egopontem/techwritertools:latest
The first time you run it, you’ll see something like this:
Unable to find image 'egopontem/techwritertools:latest' locally
latest: Pulling from egopontem/techwritertools
Status: Downloaded newer image for egopontem/techwritertools:latest
_____ _ __ __ _ _
|_ _|__ __| |_ \ \ / / _(_) |_ ___ _ _
| |/ -_) _| ' \ \ \/\/ / '_| | _/ -_) '_|
|_|\___\__|_||_| \_/\_/|_| |_|\__\___|_|
_____ _
|_ _|__ ___| |___
| |/ _ \/ _ \ (_-<
|_|\___/\___/_/__/
Welcome to Tech Writer Tools!
This is a set of command-line tools for technical writers to automate
the tedious parts of their job so they can focus on the fun parts.
You can change or delete this message by editing or deleting
~/welcome.txt.
Learn more: https://github.com/marcpaq/techwritertools
techwriter:~$ ▮
You’re ready to start coding!
Next step
Take your first steps on the command line.