vim-client - send commands to the Vim editor
- Author: James Cherti <https://www.jamescherti.com/>
- License: MIT
The vim-client command-line tools vim-client-edit, vim-client-diff and the Python module vim_client will allow you to connect to a Vim server and make it:
- Edit files or directories in new tabs,
- Compare files (similar to vimdiff),
- Evaluate expressions and return their result,
- Send commands to Vim.
It will allow you, for example, to make Vim edit or diff files from outside of Vim (e.g. from a shell like Bash, Zsh, etc.).
License
Copyright (C) 2022-2026 James Cherti.
Distributed under terms of the MIT license.
Requirements
- Python >= 3.0
- The Vim editor ('vim' or 'gvim' in $PATH. Vim must be compiled with |+clientserver|, which is the case of most Vim distributions, because the Python module vim_client uses command-line arguments
vim --remote-*)
Installation
sudo pip install vim-client
The 'vim-client-*' command-line tools
Edit a file in the current window/tab:
vim-client-edit file1
Edit multiple files/directories in separate tabs:
vim-client-edit --tab file1 file2 file3
Edit multiple files/directories in stacked horizontal splits:
vim-client-edit --split file1 file2
Edit multiple files/directories in side-by-side vertical splits (To open vertical splits on the right of the current window, use the Vim option set splitright):
vim-client-edit --vsplit file1 file2
Edit and compare up to eight files in a new tab:
vim-client-diff --tab file1 file2
Recommendations
Add aliases to ~/.bashrc
It is recommended to add the following aliases to your ~/.bashrc:
alias gvim='vim-client-edit --tab'
alias vim='vim-client-edit --tab'
alias vi='vim-client-edit --tab'
alias vimdiff='vim-client-diff --tab'
Start diff mode with vertical splits (vim-client-diff)
Add the following line to your ~/.vimrc:
set diffopt+=vertical
Create desktop launchers
File: /usr/local/share/applications/vim-client-edit.desktop
[Desktop Entry]
Name=vim-client-edit
GenericName=Vim Client Edit
Comment=Vim Client Edit
Exec=vim-client-edit --tab %F
Terminal=false
Type=Application
Keywords=Text;editor;
Icon=gvim
Categories=Utility;TextEditor;
StartupNotify=false
MimeType=text/english;text/plain;text/x-makefile;text/x-c++hdr;text/x-c++src;text/x-chdr;text/x-csrc;text/x-java;text/x-moc;text/x-pascal;text/x-tcl;text/x-tex;application/x-shellscript;text/x-c;text/x-c++;
File: /usr/local/share/applications/vim-client-diff.desktop
[Desktop Entry]
Name=vim-client-diff
GenericName=Vim Client Diff
Comment=Vim Client Diff
Exec=vim-client-diff --tab %F
Terminal=false
Type=Application
Keywords=Text;editor;
Icon=gvim
Categories=Utility;TextEditor;
StartupNotify=false
MimeType=text/english;text/plain;text/x-makefile;text/x-c++hdr;text/x-c++src;text/x-chdr;text/x-csrc;text/x-java;text/x-moc;text/x-pascal;text/x-tcl;text/x-tex;application/x-shellscript;text/x-c;text/x-c++;
Links
Metadata
Release files for vim-client 1.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| vim_client-1.0.6.tar.gz | 12.0 kB | Without provenance | Details for vim_client-1.0.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| vim_client-1.0.6-py3-none-any.whl | Python 3 | none | any | Details for vim_client-1.0.6-py3-none-any.whl |
Total release size: 21.2 kB
Release files / vim_client-1.0.6.tar.gz
| Download URL | vim_client-1.0.6.tar.gz |
|---|---|
| Size | 12.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e806c977701ee0aa5d4aa498aedca75e0337e5d606f2f47c4891afff50a585cc
|
|
BLAKE2b-256 checksum How to use checksums |
5efa6b20c0cc6c967e0b07073e9cf34c89f4992fe5e34536ea535b32f8628a55
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.10
|
Release files / vim_client-1.0.6-py3-none-any.whl
| Download URL | vim_client-1.0.6-py3-none-any.whl |
|---|---|
| Size | 9.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
aefd7c741c70c28d615a5a23b3ca83b2e5565c8e6d5098efd7ff6deb18e10165
|
|
BLAKE2b-256 checksum How to use checksums |
d175454b5e6918cca1704f2abedaf014afaaec7969bd8fcf8ad8f6089321efe0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.10
|
Security for vim-client 1.0.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.