Skip to content
Igor Malyushkin edited this page Jun 1, 2024 · 5 revisions

What is Thymus?

Thymus is a network configuration editor and browser. It facilitates navigation through huge configuration files, research of several files simultaneously, etc. Also, it is possible to edit any configuration section, save the result, compare it to the previous versions, and roll it back if it is necessary.

Made by a network engineer for network engineers!

Target audience

Network engineers of all kinds. If you spend time scrolling network configurations in your favorite text editor, Thymus is for you. It understands the context of a configuration and allows you to navigate or edit it in a more convenient way than classical editors (vscode, vim, nano, etc.).

Thymus is shipped as a PyPi package, you can easily install it anywhere (Windows, Linux, MacOS).

What Thymus can do?

Thymus understands the structure of a configuration file, parses it, and builds an abstract syntax tree. So it offers the following options:

  • You can open a local file or fetch it from a remote machine via SSH or Telnet.
  • Thymus can be run via SSH from a remote server, it does not require the server to support GUI.
  • You can navigate all available sections with the command line.
  • Edit them separately without constant searching and jumping over a huge text.
  • The edit result is saved as a piece of history, you can move back any number of steps including to the original version of the configuration.
  • The history file is saved alongside the configuration, you can continue the work at any time.
  • There is an auto-completion for your inputs that facilitates your navigation.
  • You can show a distinct section (output it on a screen) or save it to a file.
  • An output can be filtered with regular expressions (PCRE).
  • The command line supports piping, you can combine different commands. You can show the exact section, filter some lines, and save them to a file with one command.
  • The set of commands for piping is broad and can compete with sets from supported network platforms.
  • You can compare two configurations (full or selected sections) for the same platform and see what changed.
  • It is possible to compare the current configuration with one in the past.
  • All outputs are highlighted.

TUI?

TUI stands for Text-based User Interface. Simply speaking, it is a GUI, but inside your terminal (cmd.exe, PowerShell, GnomeTerminal, iterm2, etc.). All modern terminals support features required by Thymus.

Misc

  • I encountered some glitches Please, create an Issue, and we will try to help you with this problem! Also, Thymus is open-sourced and written in a popular language (Python), so you can fix your issue or even add new functionality yourself! Just create a pull request, we promise to consider it ASAP.
  • Can I offer something? Yes, the best way is to create an Issue with your question.
Clone this wiki locally