• Features
• Dependencies
• Installation
• Commands
• Support

The following are features provided by Jarvis. They all have quick keybindings to make them quick and easy to use.

1. Quick-open files - zsh & NeoVim

   Open files with simple keystrokes with fuzzy matching via command line and inside NeoVim.

   

2. Buffer management - NeoVim

   Manage buffers inside NeoVim and add/delete/search your open files.

   

3. Project searching - NeoVim

   Quickly search for simple terms or complex regular expressions in your project.

   

4. Asynchronous linting - NeoVim

5. Session management - Tmux

   Create sessions for each project with a custom layout. Quickly browse, create, and delete sessions. Tmux even keeps sessions alive if the terminal is closed.

6. Keyword auto-complete - NeoVim and zsh

   Neovim - Automatic, asynchronous keyword completion available in the current buffer via deoplete.

   Supported Languages

   • Javascript - support provided by deoplete-ternjs and TernJS.
   • Vimscript - support provided by neco-vim

   zsh - Command completion provided by zsh plugins.

7. Code Snippets - NeoVim

   Commonly used code snippets made available with a few keystrokes to reduce time and effort. Snippets available via auto-complete window removes need to memorize commands.

8. Improved JS and JSDoc syntax highlighting - NeoVim

9. Powerful Git integration - zsh & NeoVim

10. Clean, customizable UI - zsh & NeoVim

11. Improved Vim motion - NeoVim

12. Extensive documentation - Neovim, zsh, & tmux

    Each configuration file is thoroughly documented to make each setting easy to understand.

The following tools are the only ones that are required to be installed manually (if you are using OSX).

1. iTerm2 - Terminal emulator for macOS.

2. iTerm2 Oceanic Theme - Oceanic theme for Iterm. Provies seamless UI experience between Neovim + Tmux.

   Manually update your iTerm setup to use the new font (Knack Regular Nerd Font Complete is added by the installation script) and colorscheme.

Clone Jarvis into your directory of choice and run the install script. This script will install Homebrew (if it needs to) and then install all of Jarvis' dependencies.

Warning: This will move existing zsh, tmux, or nvim configurations to a backup folder inside of the installation repo.

Note: If you are on another OS, then you will have to install the supported plugins yourself. No guarantees on compatibility issues.

git clone https://github.com/ctaylo21/jarvis ~/jarvis
cd ~/jarvis
./install.sh

Installed Tools

1. Tmux - Terminal multiplexer with session management, customizable terminal layouts, and much more.

2. NeoVim - A fork of Vim that was created to be a community-driven rewrite of Vim that is focused on cleaning up the codebase and providing a way for developers to contribute to the advancement of the editor. For a list of all the plugins installed for Neovim, see the plugins file.

3. Python 3/Python Neovim Client - Implements support for python plugins in Neovim.

4. ripgrep - A blazingly fast line-oriented search tool that respects .gitignore rules.

5. fzf - A general-purpose command-line fuzzy finder that can be used with any list; files, command history, processes, hostnames, bookmarks, git commits, etc.

6. z - Tracks your most used directories and lets you quickly hop there with regexes.

7. nerd font - Custom fonts with glyphs added for icon support within NeoVim.

8. Tmux Plugin Manager - Installs and loads tmux plugins.

The following are the custom commands in Jarvis and some of the most useful default ones. Each configuration file is carefully documented to make it easy to understand. Many default commands for each tool may not be listed.

• DW - Within Denite window
• NT - Within NERDTree window
• AWV - With auto-complete window visible
• AW - Inside auto-complete window
• SP - Inside of snippet

Below are some custom key mappings as well as some default tmux commands. Not all tmux commands are included, just some of the more common ones in my workflow.

All of the following command are triggered by <c-a>: (Note the colon)

The following configurations require changes outside of Jarvis.

In order to keep your fingers near the home row, mapping caps lock to escape to get out of different vim modes can be extremely helpful.

This can be done on MacOS by following these simple steps: http://vim.wikia.com/wiki/Map_caps_lock_to_escape_in_macOS

This is especially useful for laptops that made the escape key "virutal" (I'm looking at you, Apple).

If you find any problems or bugs, please open a new issue.