A vim port to iOS.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ctags58
iVim.xcodeproj
iVim
iVimShare
iVimTests
iVimUITests
vim
README.md

README.md

iVim

iVim is a project that brings the vim editor to the iOS system.

Type :help ios in iVim for more detailed information.

Features

Font management

Besides some system and embedded monospace fonts, iVim allows users to import and use their own custom fonts. Also, iVim provides commands for more intuitive and efficient font management.

Extended keyboard

By introducing compact buttons, iVim covers as many keys as possible in its extended keyboard, so that you can input symbols without switching among key groups. Moreover, you can customize it to meet your own special needs.

Multistage language input

iVim adds support to multistage input languages such as Chinese or Japanese.

Sharing

Through sharing, iVim makes its editing power available to more apps. Via the share extension, iVim can import text or text files from, or export to other apps. Via the document picker, you can also import or edit files or directories in iCloud Drive or documents providers, without leaving iVim.

External hardware keyboard

iVim supports external hardware keyboards well, just connect your favorite one to the device and start typing. If you are using a standard English keyboard, you can remap the caps lock key, too.

How to install it

App Store

iVim is now on App Store

Source code

  1. Open iVim.xcodeproj in Xcode
  2. In General > Identity of target iVim and iVimShare, change their bundle identities to your own unique ones, and select your Apple ID to sign them. As to the App Group, it requires a paid Apple ID. If yours is, change the App Group identifier for these two targets to your own; if not, just turn them off (the only difference is that you cannot share text to iVim when it is off)
  3. Connect your device via USB to your computer, and select it as the Destination of iVim
  4. Run iVim, Xcode will install it onto your device
  5. A free Apple ID may need to do this every 7 days

Caveats

Normally, you can use iVim as vim on other platforms. However, there are some points worth mentioning due to iOS system's personality:

  1. there is no shell. You cannot call external shell commands.
  2. iVim is sandboxed. It means you don't have direct access to files of other apps if not via the sharing feature.
  3. iVim don't do autosave. Because the system could terminate apps without notifying at any time, iVim won't save its opened files automatically for the users.

Giants' shoulders

iVim was inspired by and based on 3 projects:

  1. vim - the official Vim repository
  2. Vim port from Applidium
  3. VimIOS - A port of Vim to iOS 9+

Without them, iVim wouldn't begin.

Also, without violating the copyright of Vim, feel free to make modifications to meet your own needs.