pvim

Portability CI

pvim is for those accounts where Perl is there and Vim isn't. You have a shell, files to edit, and no install privileges. Maybe it's cheap shared web hosting. Maybe it's a minimal Unix install without gcc, make, or a way to add OS packages. I'd still like a capable editor there.

The goal is a highly capable, Perl-centric Vim replacement for restricted environments, kept in one Perl file and targeting Perl 5.10+. Copy it into your own account, make it executable, and use it. The standalone file needs no root, compiler, build step or CPAN module installation.

The basics are already here: familiar motions and editing modes, search, substitution, undo/redo, shell filters, optional perltidy, and disk-backed large files. This is still an early release; visual selection, tabs, splits, dot-repeat, Vimscript and plugins aren't implemented. Text editing is byte oriented and there's no crash recovery yet. See Vim differences.

Interactive testing covers Linux and macOS. Native Windows currently supports the editing engine and batch commands. You need a full Perl standard library, a POSIX terminal, writable temporary space and permission to run your own scripts. An account limited to CGI execution without a shell won't provide the interactive terminal pvim needs. See portability evidence.

The everyday command set in Retrodores XVI2 helped set the initial scope. No XVI2 code is included. Vim is the behavior reference for implemented commands; search and substitution use Perl regexes.

pvim hello.pl
printf 'hi\n' | pvim
pvim -v
pvim --help
pvim --manual

Copy pvim to a user-writable directory such as ~/.local/bin and run chmod +x ~/.local/bin/pvim, or install the CPAN-format release tarball with cpanm. The standalone route needs no root, build step, compiler, or CPAN installation. The single file is already the standalone distribution: fat-packing adds nothing while its only required modules ship with full Perl 5.10+. Minimal distro Perl packages may split core modules into separate OS packages; see portability notes.

Download the standalone file, source archive and checksums from Releases. The clearly named pvim-standalone.pl asset is the same file. Save it as pvim, run chmod +x pvim, then ./pvim file.pl, or place it on PATH and run pvim file.pl.

Wiki and quick start cover installation, controls, Perl features and troubleshooting. Wiki sources are maintained in docs/wiki/ and synchronized from master by the development VM.

Piped or redirected input without a filename opens an unnamed, unsaved buffer; pvim - explicitly imports stdin too. Save with :w filename. Keystrokes come from /dev/tty, and screen output must remain on a terminal. In --batch mode, stdin import requires explicit -. See pvim --manual for limits and examples.

First steps

The embedded POD is the complete command and CLI reference. No tabs, splits, visual selection, dot-repeat, full Vim compatibility, or native Windows UI yet. Interactive use requires a POSIX tty and ANSI/VT100 terminal. Windows batch mode and the editing engine are tested separately from interactive terminal support.

Large files

Contents and a fixed-width line index live in private temporary files; RAM does not scale with initial file size. Opening streams/indexes the file once. Undo stores edit pieces rather than file-sized copies. A bounded line cache and changed-row rendering keep ordinary navigation and typing responsive. Saving streams contiguous pieces. Set TMPDIR to a disk with sufficient free space: roughly file size plus 24 bytes per line, plus subsequent edits and save space.

An individual line is materialized for editing/search/display. Huge single lines, pathological regexes, whole-file substitutions and heavily fragmented undo histories remain practical limits. Search/format/save are synchronous. Use a 64-bit Perl for multi-gigabyte files. See the POD's performance and safety notes.

Automation and development

pvim --batch -c '%s/old/new/g' -c w file.pl
prove -v t
perl tools/pty_test.pl
perl tools/benchmark.pl 128
perl tools/release.pl

Batch mode makes the same command engine usable in scripts and agent workflows. Writes are explicit; invalid commands exit nonzero. Shell execution is explicit through ! filters; substitution replacement text is never evaluated as Perl code.

Testing and human checklist · Portability · Changes

Source is on master. CI tests old/current Perls across Linux, macOS and Windows, plus minimal Linux distributions, optional tidy integration and real PTYs on POSIX runners. Tagged releases wait for every required CI job before publishing.

Future CPAN distribution: App::Pvim

The distribution is App::Pvim, prepared for its first CPAN trial release. GitHub releases also provide the tested App-Pvim-VERSION.tar.gz distribution. You can install that tarball into a user-owned prefix with standard Perl build tools; consumers do not need Dist::Zilla.

Author commands (with Dist::Zilla installed):

dzil build
dzil test

dist.ini uses a local author plugin to read the version and runtime from pvim, then generate script/pvim and lib/App/Pvim.pm. The module supplies the CPAN namespace and version. Run the pvim command to edit files. All application code remains in the one standalone file. The CPAN build adds no non-core runtime requirements; Perl::Tidy remains optional.

Before uploading, review the tarball and confirm the releasing account has the right PAUSE permissions. Normal CI and GitHub release jobs only build/test the distribution; they never upload to PAUSE. See CPAN preparation.