{"id":21215023,"url":"https://github.com/jamescherti/vim-client","last_synced_at":"2025-07-12T08:06:32.566Z","repository":{"id":57673123,"uuid":"476404953","full_name":"jamescherti/vim-client","owner":"jamescherti","description":"Connect to Vim and edit files, diff files, send Vim commands, evaluate Vim expressions...","archived":false,"fork":false,"pushed_at":"2025-04-09T19:23:51.000Z","size":74,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-08T15:12:21.443Z","etag":null,"topics":["vim"],"latest_commit_sha":null,"homepage":"https://github.com/jamescherti/vim-client","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jamescherti.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-31T17:13:22.000Z","updated_at":"2025-04-09T19:23:55.000Z","dependencies_parsed_at":"2024-08-13T04:49:25.938Z","dependency_job_id":null,"html_url":"https://github.com/jamescherti/vim-client","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/jamescherti/vim-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamescherti%2Fvim-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamescherti%2Fvim-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamescherti%2Fvim-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamescherti%2Fvim-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jamescherti","download_url":"https://codeload.github.com/jamescherti/vim-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamescherti%2Fvim-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264572903,"owners_count":23630366,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["vim"],"created_at":"2024-11-20T21:33:09.535Z","updated_at":"2025-07-12T08:06:32.548Z","avatar_url":"https://github.com/jamescherti.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vim-client - send commands to the Vim editor\n![License](https://img.shields.io/github/license/jamescherti/vim-client)\n\nThe **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:\n- Edit files or directories in new tabs,\n- Compare files (similar to vimdiff),\n- Evaluate expressions and return their result,\n- Send commands to Vim.\n\nIt 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.).\n\n## License\n\nCopyright (C) 2022-2025 [James Cherti](https://www.jamescherti.com).\n\nDistributed under terms of the MIT license.\n\n## Requirements\n\n- Python \u003e= 3.0\n- 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-*`)\n\n## Installation\n\n```console\nsudo pip install vim-client\n```\n\n## The 'vim-client-\\*' command-line tools\n\nEdit a file in the current window/tab:\n```console\nvim-client-edit file1\n```\n\nEdit multiple files/directories in separate tabs:\n```console\nvim-client-edit --tab file1 file2 file3\n```\n\nEdit multiple files/directories in stacked horizontal splits:\n```console\nvim-client-edit --split file1 file2\n```\n\nEdit 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`):\n```console\nvim-client-edit --vsplit file1 file2\n```\n\nEdit and compare up to eight files in a new tab:\n```console\nvim-client-diff --tab file1 file2\n```\n\n## Recommendations\n\n### Add aliases to ~/.bashrc\n\nIt is recommended to add the following aliases to your `~/.bashrc`:\n```sh\nalias gvim='vim-client-edit --tab'\nalias vim='vim-client-edit --tab'\nalias vi='vim-client-edit --tab'\nalias vimdiff='vim-client-diff --tab'\n```\n\n### Start diff mode with vertical splits (vim-client-diff)\n\nAdd the following line to your `~/.vimrc`:\n```viml\nset diffopt+=vertical\n```\n\n### Create desktop launchers\nFile: `/usr/local/share/applications/vim-client-edit.desktop`\n```\n[Desktop Entry]\nName=vim-client-edit\nGenericName=Vim Client Edit\nComment=Vim Client Edit\nExec=vim-client-edit --tab %F\nTerminal=false\nType=Application\nKeywords=Text;editor;\nIcon=gvim\nCategories=Utility;TextEditor;\nStartupNotify=false\nMimeType=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++;\n```\n\nFile: `/usr/local/share/applications/vim-client-diff.desktop`\n```\n[Desktop Entry]\nName=vim-client-diff\nGenericName=Vim Client Diff\nComment=Vim Client Diff\nExec=vim-client-diff --tab %F\nTerminal=false\nType=Application\nKeywords=Text;editor;\nIcon=gvim\nCategories=Utility;TextEditor;\nStartupNotify=false\nMimeType=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++;\n```\n\n## Links\n\n- [vim-client @PyPI](https://pypi.org/project/vim-client/)\n- [vim-client @GitHub](https://github.com/jamescherti/vim-client)\n- [Vim documentation about +clientserver and 'vim \\-\\-remote'](http://vimdoc.sourceforge.net/htmldoc/remote.html) (`:help remote.txt`)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamescherti%2Fvim-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjamescherti%2Fvim-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamescherti%2Fvim-client/lists"}