tspur

tspur

TSPUR is the terminal application with some user records presented as a table. I personally use it as cheat sheet (to keep my various usernames and passwords together with some useful facts and reminders).

Some more details you can find here: http://www.jumbleview.info/2020/04/here-we-go.html

General Description

Terminal screen consists of two areas:

• Top menu
• Table with User Records

Application starts with single argument: path to the file with data storage. Storage is encoded and password protected. If such a storage does not exists, application will ask you to enter the new password and will create a new storage.

At start application puts focus on the top menu. Hitting "Enter", while button "Select" is in focus, move the focus to the table. To put focus back on the top menu use "Esc".To navigate through the menu or the table use arrow keys. When table is in focus you may select row by hitting letter button which corresponds to the letter from which Record Name starts.

Number of table rows and columns is unlimited but it is unlikely somebody will use more than hundred rows or more then 3..5 columns. Each rows contains one cell (Record Name), which is always visible, and several values. Values on each row may be either all visible or all hidden.

Application Modes

Application supports four modes:

• Clipboard-on-Enter. If user hits "Enter" on selected cell its content is copied into clipboard.

• Clipboard-on-Select. During navigation content of selected cell is copied into clipboard.

• Visible-on-Enter. If user hits "Enter" on selected cell with hidden content it becomes visible. When cell becomes unselected its contents becomes hidden again.

• Visible-on-Select. If user selects cell with hidden content it becomes visible. When cell becomes unselected its contents becomes hidden again.

Entering the Data

User may add new records (button "Add") or edit existing (button "Edit"). To edit existing record select record on the table, then by "Esc" go to the top menu and hit button "Edit". Record maybe extended with one extra value. If there is need to add several extra values repeat the process several times.

Dependencies

It is pure Go application (no cgo needed). All the heavy lifting is done by three imported packages (and their dependencies):

"github.com/rivo/tview"
"github.com/gdamore/tcell/v2"
"github.com/atotto/clipboard"

(Code of this application is mostly tweaking around "tview" widgets.)

On Linux there is need to install "xclip", otherwise clipboard operations will not work.

Platform Support

Code was developed on Windows 10. On Windows 11 it wokrs, but instead of default Windows Terminal usage of conhost is recomended . Linux (Ubuntu 18.04) seems to be OK (just don't forget to install "xclip"). For MAC code compiles but nobody tried it.

Mouse Support

Mouse is supported. It is possible to use mouse or keyboard navigation/selection interchangeably.

Demo

To build executable and run the demo:

• Go compiler must be installed. (Application was developed with Go 1.14. Early version may be OK as well).
• Clone the project from the Github: git clone https://github/jumbleview/tspur
• Go to the directory "tspur".
• Build the executable: go build
• Go to the directory ../demo.
• Invoke either start.bat (Windows) or start.sh (Linux). As the password enter word "password".

Git integration

Optional and limited integration with Git does exists. It provides chain git operations on modified encoded storage, namely:

• At Start "tspur" checks if storage lays in the directory with valid git working tree.
• If above is "true" button "Git" included in to the top menu.
• That button triggers chain if git actions, namely: it stages storage file, commit, and push commit result to remote.

Integration does not use any Go git package, just invokes consol operation of "git" commands. Setting the account with Git provider, creating remote directory (most likely private) etc. is out of scope for this application.

Known problem

On Windows, if size of the terminal windows is changed dynamically (by dragging console corner with mouse, for example), structure of the table becomes broken. You can fix it by going back and force between top menu and the table.