Skip to main content

A terminal text editor inspired by the ISPF editor from z/OS

Project description

notispf

A terminal text editor for Linux and macOS inspired by the ISPF editor from z/OS mainframes. Runs in your terminal like vim or nano, with the prefix command area that ISPF users know and love.

Installation

Download a binary (no Python required)

Go to the Releases page and download the binary for your platform:

Platform File
Linux notispf-linux
macOS notispf-macos
Windows notispf-windows.exe

Linux / macOS:

chmod +x notispf-linux   # or notispf-macos
./notispf-linux myfile.txt

Optionally move it somewhere on your PATH:

mv notispf-linux ~/.local/bin/notispf

macOS note: macOS will warn that the binary is from an unidentified developer. To clear the warning:

xattr -d com.apple.quarantine ./notispf-macos

Then run it normally.

Via pip

pip install notispf

From source

git clone https://github.com/mrthock/notispf
cd notispf
pip install -e .

Usage

notispf <file>

Screen Layout

 notispf  filename.txt                    Line 1/42  Col 1
===> _
000001|This is the first line of your file
000002|Second line here
000003|Third line
      |~
      |~
  • Status bar (top row) — filename, modified flag [+], current line/total, cursor column, [HEX] when hex mode is active
  • Command bar (second row) — always visible; type commands here after pressing F6 to focus it
  • Prefix column (left, 6 chars) — shows line numbers; type prefix commands here
  • Text area (right of |) — edit your file
  • Message bar (bottom row) — status messages and feedback

Navigation

Key Action
Arrow keys Move cursor in text
Up (from top visible line) Move to command bar
Page Up / Page Down Scroll
Home / Ctrl+A Beginning of line
End / Ctrl+E End of line

Switching Between Areas

From Key To
Text Tab Prefix column of next line (N+1)
Text (top line) Shift+Tab Command bar
Text (any other line) Shift+Tab Prefix column of previous line (N-1)
Prefix Tab Text area of same line
Prefix Shift+Tab Text area of previous line (N-1)
Command bar Tab Prefix area of line 1
Command bar Down arrow Text area (cursor position preserved)
Command bar Escape Text area (cursor position preserved, bar stays visible)

Prefix Commands

Type a command into the prefix column, then press Enter to execute. You can stage commands on multiple lines before pressing Enter — they all execute at once.

Single-Line Commands

Command Action
D Delete line
Dn Delete n lines (e.g. D5 deletes 5)
I Insert blank line after
In Insert n blank lines
R Repeat line
Rn Repeat line n times
C Copy line to clipboard
Cn Copy n lines to clipboard
M Move line (cut to clipboard)
Mn Move n lines
A Paste clipboard after this line
B Paste clipboard before this line
O Overlay clipboard onto this line (merge; clipboard spaces don't overwrite)
On Overlay clipboard onto n lines
>n Indent right n columns (e.g. >4 adds 4 spaces)
<n Indent left n columns (removes up to n leading spaces)
HEX Replace this line with its hex representation
HEXB Insert a hex copy of this line below it
HEXA Convert a hex line back to ASCII text
UC Uppercase this line
UCn Uppercase n lines (e.g. UC3)
LC Lowercase this line
LCn Lowercase n lines

Block Commands

Type the command on the first line of the block, then again on the last line.

Command Action
DD Delete block
CC Copy block to clipboard
MM Move block (cut to clipboard)
RR Repeat block (insert a copy below)
OO Overlay clipboard onto block (merge clipboard text into block lines)
>>n Indent block right n columns
<<n Indent block left n columns

Use A, B, or O/OO on a third line to place the clipboard after copying or moving.

Example — move lines 3–6 to after line 10:

  1. Tab to line 3 prefix → type MM
  2. Arrow down to line 6 → type MM
  3. Arrow down to line 10 → type A
  4. Press Enter

Exclude / Show Commands

Command Action
X Exclude line from display (collapse into fold row)
Xn Exclude n lines
S Show (un-exclude) line or the entire fold group it belongs to
Sn Show n lines
XX Exclude block
SS Show block

Excluded lines are collapsed into a single fold row showing the count. Use SHOW ALL on the command line to reveal everything at once.

Prefix Mode Controls

Key Action
Enter Execute all staged prefix commands
Escape Cancel all staged commands and exit prefix mode
↑ / ↓ Move between lines (keeps staged commands)

Command Line

The command bar is always visible just below the status bar. Press F6 to focus it (the cursor moves to ===>), type a command, and press Enter to execute. After the command runs the input clears, the result appears in the message bar, and the cursor stays at ===> ready for another command. Press Escape or Down arrow to return to the text. Press F6 again while focused to hide the bar entirely; press F6 once more to bring it back.

File Commands

Command Action
SAVE Save file
FILE Save and exit
CANCEL or QUIT or CAN Exit without saving

Copy File

Command Action
COPY filename Save a copy of the current file to filename (current file path unchanged)

Undo / Redo

Command Action
UNDO Undo last change
REDO Redo last undone change

Hex Mode

Command Action
HEX ON Convert entire file to hex (e.g. Hello48 65 6C 6C 6F)
HEX OFF Convert hex back to text

[HEX] appears in the status bar while hex mode is active. HEX ON and HEX OFF each count as a single undo step.

Exclude and Delete

EXCLUDE 'pattern'
EXCLUDE 'pattern' ALL
EXCLUDE 'pattern' n

DELETE 'pattern'
DELETE 'pattern' ALL
DELETE 'pattern' n
DELETE X ALL
DELETE NX ALL
  • EXCLUDE 'pattern' — exclude the next matching line from display
  • EXCLUDE 'pattern' ALL — exclude all matching lines
  • EXCLUDE 'pattern' n — exclude the next n matching lines
  • DELETE 'pattern' — delete the next matching line
  • DELETE 'pattern' ALL — delete all matching lines
  • DELETE X ALL — delete all currently excluded lines
  • DELETE NX ALL — delete all non-excluded lines

Show

Command Action
SHOW ALL Reveal all excluded lines

Display

Command Action
COLS Toggle the column ruler on/off
CLEAR / RESET / RES Clear the current search highlight
HELP Open the help screen

Find and Change

FIND 'text'
CHANGE 'old' 'new'
CHANGE 'old' 'new' ALL
CHANGE 'old' 'new' ALL .labelA .labelB

Both single and double quotes are accepted as delimiters.

Aliases: F for FIND, C for CHANGE, CAN for CANCEL, RESET/RES for CLEAR.

  • FIND — locate next occurrence (case-insensitive by default)
  • CHANGE — replace next occurrence
  • CHANGE ... ALL — replace all occurrences in file
  • CHANGE ... ALL .A .B — replace all occurrences between labeled lines

Labels

Type .A, .B etc. in the prefix column to assign a label to a line. Labels are used to define ranges for CHANGE ... ALL .A .B.

Function Keys

Key Action
F1 Help
F3 Save and exit
F5 Repeat last FIND (RFIND)
F6 Focus command bar (or hide it if already focused)
F7 / Page Up Scroll up
F8 / Page Down Scroll down
F10 Scroll left
F11 Scroll right
F12 Exit without saving
Ctrl+Z Undo last change
Ctrl+Y Redo last undone change

Contributing

notispf is designed to be easy to extend. Adding a new prefix command takes three steps:

  1. Write a handler function in notispf/commands/line_cmds.py:
def cmd_trim(buffer: Buffer, line_idx: int, count: int) -> EditorResult:
    for i in range(line_idx, min(line_idx + count, len(buffer))):
        buffer.replace_line(i, buffer.lines[i].text.rstrip())
    return EditorResult(success=True)
  1. Register it in the same file's register() function:
registry.register_line_cmd(CommandSpec("T", cmd_trim, description="Trim trailing whitespace"))
  1. Add tests in tests/test_line_cmds.py.

That's it — no changes to the prefix state machine, display, or app controller needed.

See ARCHITECTURE.md for a deeper overview of the codebase.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

notispf-1.1.0.tar.gz (30.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

notispf-1.1.0-py3-none-any.whl (26.1 kB view details)

Uploaded Python 3

File details

Details for the file notispf-1.1.0.tar.gz.

File metadata

  • Download URL: notispf-1.1.0.tar.gz
  • Upload date:
  • Size: 30.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for notispf-1.1.0.tar.gz
Algorithm Hash digest
SHA256 bc5dc5ed741784b16234d0fb20dacb8e4d818c6efa30ae20c78b4e914a15ab55
MD5 064a63158e108a556f5db1aa9c8fee31
BLAKE2b-256 def94a05efa309ba079771dcd66d203ca3ab26c5af709f6a9f423c9b67afb895

See more details on using hashes here.

Provenance

The following attestation bundles were made for notispf-1.1.0.tar.gz:

Publisher: release.yml on mrthock/notispf

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file notispf-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: notispf-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 26.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for notispf-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 12aabdfbe8715118a56b4c6d6aaea1cdd5a0821f9c4ed546c1c86a22287d4c2e
MD5 70e7bb212e2003855a1ac4b8114d3abb
BLAKE2b-256 3238f89c73d15df6552e5fcdbbee2c5b1ec4d58e41ce3af60f8be10246502074

See more details on using hashes here.

Provenance

The following attestation bundles were made for notispf-1.1.0-py3-none-any.whl:

Publisher: release.yml on mrthock/notispf

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page