An open API service indexing awesome lists of open source software.

https://github.com/tani/vip

VIP is a vim plugin manager
https://github.com/tani/vip

vim vim-plugin

Last synced: 3 months ago
JSON representation

VIP is a vim plugin manager

Awesome Lists containing this project

README

        

# VIP: VIm Plugin manager

██╗░░░██╗██╗██████╗░
██║░░░██║██║██╔══██╗
╚██╗░██╔╝██║██████╔╝
░╚████╔╝░██║██╔═══╝░
░░╚██╔╝░░██║██║░░░░░
░░░╚═╝░░░╚═╝╚═╝░░░░░

This software is still ALPHA quality. The APIs will be likely to change.

## Installation

Please the prebuilt binary download
from [releases](https://github.com/tani/vip/releases/tag/nightly).

**This binary does no require the installtion of Deno.**

For the developers, you can install the nightly version using Deno.

Install:

```
deno install --allow-env --allow-net --allow-read --allow-write --allow-run --name vip https://raw.githubusercontent.com/tani/vip/master/vip.ts
```

## Quickstart

Add the package path in `~/.vimrc` or `~/.config/nvim/init.vim`.

```vim
exe 'set packpath^=' .. expand('~/.vip/src')
```

Run `add` subcommand to install a package.

```
vip add michaelb/do-nothing.vim
```

Now, we are ready to use Vim.

## Usage

### Add new package

```
vip add michaelb/do-nothing.vim ...
```

`--opt` option sets the type of the plugin `opt`

```
vip add --opt michaelb/do-nothing.vim
```

### Remove package

```
vip remove do-nothing.vim ...
```

`--opt` option sets the type of the plugin `opt`

```
vip remove --opt do-nothing.vim
```

### Show packages

```
vip list
```

`--opt` option sets the type of the plugin `opt`

```
vip list --opt
```

### Update and synchronize packages

```
vip sync
```

### Show history of packages

```
vip log
```

### Aggressive optimization

This command merges all runtime paths into one.
Not that it may break some packages.

```
vip bundle
```

You can load optimized packags as follows.

```vim
exe 'set packpath^=' .. expand('~/.vip')
```

### Upgrade VIP

**NOTE** This subcommand is not for the binary distribution.

```
vip upgrade
```

## Bootstrap Vim Interface (Optional)

You need to instal denops `vip add tani/vip vim-denops/denops.vim`

- `:VipAdd michaelb/do-nothing.vim` to add package
- `:VipAddOpt michaelb/do-nothing.vim` to add opt-pacakge
- `:VipRemove michaelb/do-nothing.vim` to remove pacakge
- `:VipRemoveOpt michaelb/do-nothing.vim` to remove opt-package
- `:VipList` to show all package
- `:VipListOpt` to show all opt-package
- `:VipSync` to update and synchronize packages
- `:VipLog` to show history of packages
- `:VipBundle` to bundle whole packages

## Copyright and License

Copyright (c) 2022 TANIGUCHI Masaya. All rights reserved.

This software is licensed under the MIT License https://git.io/mit-license