Skip to content

A plugin for viewing Vim and Neovim startup event timing information.

License

Notifications You must be signed in to change notification settings

dstein64/vim-startuptime

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

build

vim-startuptime

vim-startuptime is a plugin for viewing vim and nvim startup event timing information. The data is automatically obtained by launching (n)vim with the --startuptime argument. See :help startuptime-configuration for details on customization options.

Requirements

  • vim>=8.0.1453 or nvim>=0.3.1
    • The plugin may work on earlier versions, but has not been tested.
    • The plugin depends on compile-time features for vim (not applicable for nvim).
      • +startuptime is required.
      • +timers is recommended, to capture all startup events.
      • +terminal is required.

Installation

A package manager can be used to install vim-startuptime.

Examples
  • Vim8 packages:
    • git clone https://github.com/dstein64/vim-startuptime ~/.vim/pack/plugins/start/vim-startuptime
  • Vundle:
    • Add Plugin 'dstein64/vim-startuptime' to ~/.vimrc
    • :PluginInstall or $ vim +PluginInstall +qall
  • Pathogen:
    • git clone --depth=1 https://github.com/dstein64/vim-startuptime ~/.vim/bundle/vim-startuptime
  • vim-plug:
    • Add Plug 'dstein64/vim-startuptime' to ~/.vimrc
    • :PlugInstall or $ vim +PlugInstall +qall
  • dein.vim:
    • Add call dein#add('dstein64/vim-startuptime') to ~/.vimrc
    • :call dein#install()
  • NeoBundle:
    • Add NeoBundle 'dstein64/vim-startuptime' to ~/.vimrc
    • Re-open vim or execute :source ~/.vimrc

Usage

  • Launch vim-startuptime with :StartupTime.
  • Press K on events to get additional information.
  • Press gf on sourcing events to load the corresponding file in a new split.
  • The key sequences above can be customized (:help startuptime-configuration).
  • Times are in milliseconds.

Documentation

Documentation can be accessed with either:

:help vim-startuptime

or:

:StartupTime --help

The underlying markup is in startuptime.txt.

There is documentation on the following topics.

Topic :help {subject}
Arguments startuptime-arguments
Modifiers startuptime-modifiers
Vim Options startuptime-vim-options
Configuration startuptime-configuration
Color Customization startuptime-color-customization

License

The source code has an MIT License.

See LICENSE.