Make Firefox/Thunderbird look and behave like Vim
To beginners: Welcome to the Vimperator-labs!
This README isn't written usage and help for the add-on itself. Try
:helpcommand after installing add-on for details.
End of Life and Alternatives
Vimperator will stop working in up-to-date copies of Firefox with the release of Firefox 57 on November 14th due to a large breaking change in how extensions and add-ons are written (#705).
It's not all doom and gloom, though! Here are your options (#729):
Stay with vimperator, but use an older release of Firefox or a Firefox fork
- The Extended Service Release (ESR) of Firefox is still on Firefox 52 and will be vimperator compatible until May 2018.
- Waterfox is a firefox fork that merges security patches and intends to maintain compatibility with XPCOM/XUL plugins like vimperator. Note that Firefox is due to undergo rapid internal change and that waterfox will be more and more on their own as time goes on.
Use an add-on compatible with the new webextension API
- It is not currently possible to match the vimperator feature list in a WebExtension. Some work is being done to rectify this
- cVim (Chrome/Chromium only) - features regex search, commandline with completion, autocmds (via
- Tridactyl (Firefox only) - aims to eventually match the vimperator experience with working beta versions currently available on AMO
Use a less fully-featured add-on compatible with the new WebExtension API
- These add-ons provide great, configurable, vim-like shortcuts and hints mode
- By design they do not offer insert or command mode, custom commands, autocmds, vim-style maps and so on
- Vimium - "The Hacker's Browser. Vimium provides keyboard shortcuts for navigation and control in the spirit of Vim."
- Saka-key - "Put away your mouse. Saka Key lets you control your browser with keyboard shortcuts."
- Vim Vixen - "An add-on which allows you to navigate with vim-like bindings."
Surrender your other add-ons and use a browser with built-in vim bindings
- Not tabbed (Use a tabbed window manager or something that supports XEmbed)
Muttator is not affected by these changes.
See also Home page.
Writing efficient user interfaces is the main maxim, here at Vimperator labs.
We often follow the Vim way of doing things, but extend its principles when
Towards this end, we've created the liberator library for Mozilla based applications, to encapsulate as many of these generic principles as possible, and liberate developers from the tedium of reinventing the wheel.
Currently, these applications are using this library:
Vimperator, the flagship project from Vimperator labs, creates a Vim-like Firefox.
Vimperator is a Firefox browser extension with strong inspiration from the Vim
text editor, with a mind towards faster and more efficient browsing. It has
similar key bindings and you could call it a modal web browser, as key bindings
differ according to which mode you are in. For example, it has a special Hint
mode, where you can follow links easily with the keyboard only. Also most
functionality is available as commands, typing
:back will go back within the
current page history, just like hitting the back button in the toolbar.
Muttator is to Thunderbird what Vimperator is to Firefox. Combines the best aspects of Vim and Mutt.
Muttator is a free add-on for the Thunderbird mail client, which makes it look
and behave like the Vim text editor. It has similar key bindings and you could
call it a modal mail client, as key bindings differ according to which mode you
are in. For example, it the same keys can select the next message while the
message list has focus or can scroll down an existing message when the message
preview is selected. It also adds commands for accessing most Thunderbird
:contact -lastname "Vimperator" firstname.lastname@example.org
will add Vimperator's mailing list to your address book.
- Vim-like keybindings (
- Ex commands (
:open www.foo.com, ...)
- Tab completion available for all commands with support for 'longest' matching when set in 'wildmode'
- Extensions! Yes, you can extend Vimperator's functionality with scripts just like you can extend Firefox with extensions
:echo windowand even context-sensitive tab completion
- Hit-a-hint like navigation of links (start with
fto follow a link)
- Advanced completion of bookmark and history URLs (searching also in title, not only URL)
- Vim-like statusline with a wget-like progress bar
- Minimal GUI (easily hide useless menubar and toolbar with
- Ability to
- Easy quick searches (
:open foowill search for "foo" in google,
:open ebay terminatorwill search for "terminator" on ebay) with support for Firefox keyword bookmarks and search engines
- Count supported for many commands (
3<C-o>will go back 3 pages)
- Beep on errors
- Marks support (
mato set mark 'a' on a webpage,
'ato go there)
- QuickMarks support (quickly go to previously marked web pages with
feedkeys()for script writers)
:timesupport for profiling
- Move the text cursor and select text with vim keys and a visual mode
- External editor support
- Macros to replay key strokes
- AutoCommands to execute action on certain events
- A comprehensive
:help, explaining all commands, mappings and options
- Much more...
Note that Vimperator doesn't support multi-process aka Electrolysis (e10s), it's necessary to disable e10s to use the add-on.
Download signed add-on from addons.mozilla.org (AMO) 1
- Enter Add-ons page.
Continue to Downloadbutton.
Add to Firefoxbutton.
Download unsigned 2 add-on from github.com (Github)
- Enter Releases page.
vimperator-3.N.N.xpilink under Downloads topic.
Build own version (and signing) See Build own version topic.
2 Since version 48, installing add-on to Firefox has required signing. Unsigned add-on is for Unbranded Builds. See mozilla wiki.
Build own version
Unsigned (for Unbranded Builds)
Signed (for Firefox 48+)
Instructions for building this can be found in vimperator/private.properties.in. See also MDN document (developer.mozilla.org) for details about signing and distribution.
There are necessary four steps to use own version.
- Prepare "AMO API key" and "jpm" if first time
- Build unsigned add-on
- Submit unsigned add-on to AMO
- Install signed add-on to Firefox
- Addition: Use Command-line interface (CLI) to build and submit
Prepare AMO API key and jpm
Build unsigned add-on
Clone repository and create private.properties:
git clone https://github.com/vimperator/vimperator-labs.git cd vimperator-labs/vimperator cp private.properties.in private.properties
Then edit private.properties so that it looks something like:
VERSION := $(VERSION).$(shell date '+%Y%m%d%H%M%S') UUID = vimperator@<uniqueid> # e.g. vimperator@<yourdomain> AMO_API_KEY = <your API key> # AKA "Issuer" AMO_API_SECRET = <your API secret> UPDATE_URL = UPDATE_URL_XPI =
The unsigned XPI should appear in
Submit unsigned add-on to AMO
|Have you ever submitted own version to AMO?||How to submit|
|No, I'd like to register own version.||Enter
How to Distribute this Version, upload the XPI selecting
|Yes, I'd like to update own version.||Enter
Manage My Submissions, upload the XPI from your Vimperator's
Then the validation starts. Finally, automatically validation XPI finishes,
Sign add-on button to sign.
Install signed add-on to Firefox
Install it via the link in your AMO developer account (find your Vimperator's
Manage Status & Versions). The new UUID makes it a new add-on, so don't
forget to disable the old version.
Use CLI to build and submit
After once you signed the add-on, you are able to update the add-on using CLI.
cd vimperator-labs/vimperator make sign
Vimperator is in need of collaborators! Help bring vimperator into the age of e10s!
Please check existing issues for similar issues before opening a new issue. See CONTIRIBUTING.md for details.
Vimperator-labs is released under the MIT license, see License.txt.