c9s / vimana

Vimana is an easy to use system for searching , installing, and downloading vim script. Vimana provides a command-line interface such like aptitude programe on Debian linux, for you to search , download , install , upgrade scripts from http://www.vim.org (vimonline site).

Vimana

Vimana is an easy-to-use system for searching, installing, and downloading vim script.

Vimana provides a command-line interface such like aptitude program on Debian linux, for you to search, download, install, upgrade scripts from http://www.vim.org (vim online site).

Vimana can install a vim script package to your vim runtime path automatically by inspecting the content of archive file or vim script. for example, if an archive file contains 'syntax', 'plugin', 'indent' directory, then these files should be installed to ~/.vim/ directory. if it is a vim color scheme, then it should be put into ~/.vim/colors/ and prompt for setting the installed colorscheme as default.

Rakefile, makefile, vimball installation are supported.

For scripts have their own docs, Vimana will try to update helptags after the installations.

NOTE: Vimana only provides search, info, and install commmands currently.

INSTALLATION

For First Time CPAN Users:

Install miyagawa's cpanminus , which doesn't require any complex configurations. It's easy, clean and faster than the old CPAN shell:

$ mkdir ~/bin
$ wget http://xrl.us/cpanm -O ~/bin/cpanm
$ chmod +x ~/bin/cpanm

Run cpanminus to install Vimana from CPAN:

$ cpanm -n Vimana

Or git clone from github:

$ cpanm -n http://github.com/c9s/Vimana/tarball/master

For non-root permission users, cpanm will install modules into ~/perl5 directory. so you will need to export PERL5LIB, add below line in your .bashrc or .zshrc:

export PERL5LIB=~/perl5/lib/perl5;$PERL5LIB

USAGE

INSTALL

To install snipmate package:

$ vimana install snipmate

To install from git or svn:

$ vimana install git:git://github.com/c9s/hypergit.vim.git
$ vimana install git:[email protected]:c9s/hypgergit.vim.git
$ vimana install svn:svn+ssh://path/to/your/repo

To install from GitHub:

$ vimana install gh:c9s/perlomni.vim
$ vimana install gh:Shougo/vimfiler.vim

To install snipmate.vim package to another runtime path:

$ vimana i snipmate -r ~/.vim-other-rtp

# or

$ vimana install snipmate --runtime-path ~/.vim-other-rtp

To install rails.vim package:

$ vimana install rails.vim

SEARCH

to search rails

$ vimana search rails

to search colorscheme:

$ vimana search -t color

to search ftplugin:

$ vimana search -t ftplugin

to search ftplugin and "abc" keyword:

$ vimana search -t ftplugin abc

UPDATE

to update index

$ vimana update

DOWNLOAD

to download:

$ vimana download markdown-syntax.vim

REMOVE

to remove a package:

$ vimana remove fuzzyfinder

to force remove a package:

$ vimana remove -f fuzzyfinder

LIST INSTALLED PACKAGES

to list installed packages:

$ vimana installed

to list installed package content:

$ vimana installed snipmate

RATE

to rate plugin:

$ vimana rate snipmate 2  # rate life changing

COMMAND ALIAS

$ vimana i   # alias of install command.
$ vimana s   # alias of search command.
$ vimana d   # alias of download command.

TESTED CASES

$ vimana i hypergit.vim
$ vimana i the-nerd-tree
$ vimana i autocomplpop
$ vimaan i gsession.vim
$ vimana i snipmate
$ vimana i svg.vim
$ vimana i railscasts-theme
$ vimana i dark-ruby
$ vimana i bufexplorer.zip
$ vimana i xml.vim
$ vimana i cctree
$ vimana i markdown-syntax
$ vimana i gist.vim
$ vimana i googlereader.vim


$ vimana i jslint.vim
$ vimana i fakeclip

$ vimana remove fakeclip

$ cd snipmate.git
$ vimana install .    # install from current path.

$ vimana installed   # list installed scripts

$ vimana installed gist.vim  # list installed content of gist.vim

$ vimana upgrade gist.vim

MAKE YOUR PLUGIN INSTALLABLE

1. use vim runtime directory structure like this:

    foo.tar.gz:
        plugin/foo.vim
        syntax/foo.vim
        doc/foo.txt
   

2. add type info in your vim script file:

    " script type: plugin
   

uppercase also available:

    " Script Type: plugin

then the script will be installed into ~/.vim/plugin/.

SUPPORT AND DOCUMENTATION

After installing, you can find documentation for this module with the perldoc command.

perldoc Vimana

IRC Channel:

#vimana on irc.freenode.net

You can also look for information at:

vim-addon-manager : another vim script manager (which is written in VimL).
    http://github.com/MarcWeber/vim-addon-manager

RT, CPAN's request tracker
    http://rt.cpan.org/NoAuth/Bugs.html?Dist=Vimana

AnnoCPAN, Annotated CPAN documentation
    http://annocpan.org/dist/Vimana

CPAN Ratings
    http://cpanratings.perl.org/d/Vimana

Search CPAN
    http://search.cpan.org/dist/Vimana

AUTHORS

• c9s (Cornelius) [email protected]

Contributors

Ordered by alphabet (sort)

• arowla
• drbean
• mattn
• tokuhirom
• ujihisa
• zentooo

COPYRIGHT AND LICENCE

Copyright (C) 2007 You-An Lin 林佑安 ( Cornelius / c9s )

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

vimana's Issues

make test faild

log:

PERL_DL_NONLAZY=1 /usr/bin/perl "-MExtUtils::Command::MM" "-e" "test_harness(0, 'inc', 'blib/lib', 'blib/arch')" t/00-commands.t t/00-install.t t/00-load.t t/00-path.t t/00-update.t t/01-package.t t/01-record.t
t/00-commands....ok 1/6                                                      
#   Failed test 'use Vimana::Command::Install;'
#   at t/00-commands.t line 8.
#     Tried to use 'Vimana::Command::Install'.
#     Error:  Can't locate YAML.pm in @INC (@INC contains: lib /home/renn999/Vimana/inc /home/renn999/Vimana/blib/lib /home/renn999/Vimana/blib/arch /etc/perl /usr/local/lib/perl/5.10.0 /usr/local/share/perl/5.10.0 /usr/lib/perl5 /usr/share/perl5 /usr/lib/perl/5.10 /usr/share/perl/5.10 /usr/local/lib/site_perl .) at lib/Vimana/Record.pm line 9.
# BEGIN failed--compilation aborted at lib/Vimana/Record.pm line 9.
# Compilation failed in require at lib/Vimana/Command/Install.pm line 10.
# BEGIN failed--compilation aborted at lib/Vimana/Command/Install.pm line 10.
# Compilation failed in require at (eval 21) line 2.
# BEGIN failed--compilation aborted at (eval 21) line 2.
t/00-commands....NOK 3/6# Looks like you failed 1 test of 6.                 
t/00-commands....dubious                                                     
    Test returned status 1 (wstat 256, 0x100)
DIED. FAILED test 3
    Failed 1/6 tests, 83.33% okay
t/00-install.....ok 1/15                                                     
#   Failed test 'use Vimana::AutoInstall;'
#   at t/00-install.t line 15.
#     Tried to use 'Vimana::AutoInstall'.
#     Error:  Can't locate DateTime.pm in @INC (@INC contains: lib /home/renn999/Vimana/inc /home/renn999/Vimana/blib/lib /home/renn999/Vimana/blib/arch /etc/perl /usr/local/lib/perl/5.10.0 /usr/local/share/perl/5.10.0 /usr/lib/perl5 /usr/share/perl5 /usr/lib/perl/5.10 /usr/share/perl/5.10 /usr/local/lib/site_perl .) at lib/Vimana/AutoInstall.pm line 14.
# BEGIN failed--compilation aborted at lib/Vimana/AutoInstall.pm line 14.
# Compilation failed in require at (eval 23) line 2.
# BEGIN failed--compilation aborted at (eval 23) line 2.
t/00-install.....NOK 6/15                                                    
#   Failed test 'use Vimana::Command::Install;'
#   at t/00-install.t line 16.
#     Tried to use 'Vimana::Command::Install'.
#     Error:  Can't locate YAML.pm in @INC (@INC contains: lib /home/renn999/Vimana/inc /home/renn999/Vimana/blib/lib /home/renn999/Vimana/blib/arch /etc/perl /usr/local/lib/perl/5.10.0 /usr/local/share/perl/5.10.0 /usr/lib/perl5 /usr/share/perl5 /usr/lib/perl/5.10 /usr/share/perl/5.10 /usr/local/lib/site_perl .) at lib/Vimana/Record.pm line 9.
# BEGIN failed--compilation aborted at lib/Vimana/Record.pm line 9.
# Compilation failed in require at lib/Vimana/Command/Install.pm line 10.
# BEGIN failed--compilation aborted at lib/Vimana/Command/Install.pm line 10.
# Compilation failed in require at (eval 58) line 2.
# BEGIN failed--compilation aborted at (eval 58) line 2.
t/00-install.....NOK 7/15# Looks like you failed 2 tests of 15.              
t/00-install.....dubious                                                     
    Test returned status 2 (wstat 512, 0x200)
DIED. FAILED tests 6-7
    Failed 2/15 tests, 86.67% okay (less 8 skipped tests: 5 okay, 33.33%)
t/00-load........ok 1/7                                                      
#   Failed test 'use Vimana::AutoInstall;'
#   at t/00-load.t line 12.
#     Tried to use 'Vimana::AutoInstall'.
#     Error:  Can't locate DateTime.pm in @INC (@INC contains: lib /home/renn999/Vimana/inc /home/renn999/Vimana/blib/lib /home/renn999/Vimana/blib/arch /etc/perl /usr/local/lib/perl/5.10.0 /usr/local/share/perl/5.10.0 /usr/lib/perl5 /usr/share/perl5 /usr/lib/perl/5.10 /usr/share/perl/5.10 /usr/local/lib/site_perl .) at lib/Vimana/AutoInstall.pm line 14.
# BEGIN failed--compilation aborted at lib/Vimana/AutoInstall.pm line 14.
# Compilation failed in require at (eval 23) line 2.
# BEGIN failed--compilation aborted at (eval 23) line 2.
t/00-load........NOK 6/7# Testing Vimana 0.09, Perl 5.010000, /usr/bin/perl  
# Looks like you failed 1 test of 7.
t/00-load........dubious                                                     
    Test returned status 1 (wstat 256, 0x100)
DIED. FAILED test 6
    Failed 1/7 tests, 85.71% okay
t/00-path........Undefined subroutine &Vimana::Util::which called at t/00-path.t line 5.
# Looks like your test exited with 255 before it could output anything.
t/00-path........dubious                                                     
    Test returned status 255 (wstat 65280, 0xff00)
DIED. FAILED test 1
    Failed 1/1 tests, 0.00% okay
t/00-update......&Digest::SHA1::sha1_hex function called with reference argument at /usr/local/share/perl/5.10.0/Cache/File.pm line 395.
t/00-update......ok                                                          
t/01-package.....ok                                                          
t/01-record......
#   Failed test 'use Vimana::Record;'
#   at t/01-record.t line 8.
#     Tried to use 'Vimana::Record'.
#     Error:  Can't locate YAML.pm in @INC (@INC contains: lib /home/renn999/Vimana/inc /home/renn999/Vimana/blib/lib /home/renn999/Vimana/blib/arch /etc/perl /usr/local/lib/perl/5.10.0 /usr/local/share/perl/5.10.0 /usr/lib/perl5 /usr/share/perl5 /usr/lib/perl/5.10 /usr/share/perl/5.10 /usr/local/lib/site_perl .) at lib/Vimana/Record.pm line 9.
# BEGIN failed--compilation aborted at lib/Vimana/Record.pm line 9.
# Compilation failed in require at (eval 6) line 2.
# BEGIN failed--compilation aborted at (eval 6) line 2.
"my" variable $find masks earlier declaration in same scope at t/01-record.t line 61.
Can't locate object method "add" via package "Vimana::Record" at t/01-record.t line 15.
# Looks like you planned 8 tests but ran 1.
# Looks like you failed 1 test of 1 run.
# Looks like your test exited with 255 just after 1.
t/01-record......dubious                                                     
    Test returned status 255 (wstat 65280, 0xff00)
DIED. FAILED tests 1-8
    Failed 8/8 tests, 0.00% okay
Failed Test     Stat Wstat Total Fail  List of Failed
-------------------------------------------------------------------------------
t/00-commands.t    1   256     6    1  3
t/00-install.t     2   512    15    2  6-7
t/00-load.t        1   256     7    1  6
t/00-path.t      255 65280     1    2  1
t/01-record.t    255 65280     8   15  1-8
8 subtests skipped.
Failed 5/7 test scripts. 13/57 subtests failed.
Files=7, Tests=57,  8 wallclock secs ( 1.59 cusr +  0.18 csys =  1.77 CPU)
Failed 5/7 test programs. 13/57 subtests failed.
make: *** [test_dynamic] Error 255

Windows Support

I've tested some plugin in Vimana on windows (with strawberry perl installed)

gist.vim could be installed . but at the first time, the directory "plugin" will be created as a file. so that gist.vim can not be copied into plugin directory. I manully removed directory and create plugin directory , and it works.

C:\Documents and Settings\c9s\Desktop\Vimana-2010.03419\Vimana-2010.03419>perl - Ilib bin/vimana install fuzzyfinder
Plugin will be installed to vim runtime path: C:\Documents and Settings\c9s\vimfiles

Canonical name: fuzzyfinder
Downloading from: http://www.vim.org/scripts/download_script.php?src_id=11852
Saving file to C:\DOCUME~1\c9s\LOCALS~1\Temp\vimana-teimnp\vim-fuzzyfinder.zip
Extracting to C:\DOCUME~1\c9s\LOCALS~1\Temp/vimana-yhyeln.
Extracting to: C:\DOCUME~1\c9s\LOCALS~1\Temp/vimana-yhyeln
format error: bad signature: 0x14031402 at offset 55175 in file C:\DOCUME~1\c9s\
    LOCALS~1\Temp\vimana-teimnp\vim-fuzzyfinder.zip at lib/Vimana/PackageFile.pm line 195
    Can't call method "extractTree" on an undefined value at 
    C:/strawberry/perl/site/lib/Archive/Any/Plugin/Zip.pm line 47.

here is my log:

C:\Documents and Settings\c9s\Desktop\Vimana-2010.03419\Vimana-2010.03419>
    perl -Ilib bin/vimana install autocomplpop

Plugin will be installed to vim runtime path: C:\Documents and Settings\c9s\vimf
iles
Canonical name: autocomplpop
Downloading from: http://www.vim.org/scripts/download_script.php?src_id=11894
Saving file to C:\DOCUME~1\c9s\LOCALS~1\Temp\vimana-agigaj\vim-autocomplpop.zip

Extracting to C:\DOCUME~1\c9s\LOCALS~1\Temp/vimana-rwcefm.
Extracting to: C:\DOCUME~1\c9s\LOCALS~1\Temp/vimana-rwcefm
format error: bad signature: 0x1402014b at offset 13705 in file C:\DOCUME~1\c9s\
LOCALS~1\Temp\vimana-agigaj\vim-autocomplpop.zip
    at lib/Vimana/PackageFile.pm line 195
    Can't call method "extractTree" on an undefined value 
    at C:/strawberry/perl/site/lib/Archive/Any/Plugin/Zip.pm line 47.

C:\Documents and Settings\c9s\Desktop\Vimana-2010.03419\Vimana-2010.03419>

Can't locate VImana.pm in @INC

After successfully installed Vimana with cpanminus "cpanm http://github.com/c9s/Vimana/tarball/master", following error occurred:

Can't locate Vimana.pm in @inc (@inc contains: /Library/Perl/Updates/5.10.0 /System/Library/Perl/5.10.0/darwin-thread-multi-2level /System/Library/Perl/5.10.0 /Library/Perl/5.10.0/darwin-thread-multi-2level /Library/Perl/5.10.0 /Network/Library/Perl/5.10.0/darwin-thread-multi-2level /Network/Library/Perl/5.10.0 /Network/Library/Perl /System/Library/Perl/Extras/5.10.0/darwin-thread-multi-2level /System/Library/Perl/Extras/5.10.0 .) at /opt/local/bin/vimana line 4.
BEGIN failed--compilation aborted at /opt/local/bin/vimana line 4.

ScriptType

Whenever a plugin has no script type defined, Vimana does not know what to do with it.

Since many of the recent plugins just try to support pathogen whenever they are developed, they do not care about setting a type anymore. How should we address that? Should we just add the type to every project we want to support, or should we check for the project directory tree, and if they are pathogen compatible, distribute them according to the directory tree?

e.g.: If foobar project has a foobar/syntax/syntax.vim file, we could assume this is a syntax plugin.

make test failures

http://gist.github.com/307459
Failed 8/12 test programs. 44/72 subtests failed.

README info should be in help also

The various options that are available to 'install' are not listed by 'vimana help install', e.g., vimana install git:...

Would be great to have all the options and examples in the help output.

replace Any::Archive

Any::Archive is buggy, since we need to support bzip2, gz, tar filetypes.
and seems doesnt work on Windows.

Add Backup command to backup installed packages

VImana is a useful tool to search and install needed vim files, but is it possible to backup installed packages ?

For me , when typing :

vimana installed 

I would get installed vim packages shown below :

FuzzyFinder [auto]
gist.vim [text]
javascript.vim [text]
matchit.zip [auto]
rails.vim [auto]
snipmate [auto]
supertab-continued. [vimball]
template.vim [auto]
the-nerd-tree [auto]
vim-coffee-script [auto]

After a quick survey , it seems that Vimana stores all file informations under $ENV{VIM_RECORD_DIR} or the other one.

So there may can have a command called :

vimana backup 

After doing so , Vimana would help users to backup a metafile that stores all package names ( which were installed by Vimana from http://www.vim.org/scripts/ ) in JSON format ( like what @c9s do in record directory )

{
    "installed_packages" : [
        "FuzzyFInder" ,
        "rails.vim", 
        ... etc
    ]
}

If one day, a user wants to move from one working environment to another one, (s)he just has to transmit the metafile and anything will be done by Vimana on the free !

The final backup command may be :

vimana backup [options] [path]

with options :

-l, --load 
    load the metafile from the path and will call "install" command to install packages one by one

... to be continued.

Hope this idea helps and thanks for your reading ;)

Check if .vim/colors exists

if ~/.vim/colors doesn't exist, vimana i peaksea (a color scheme) will print peaksea.vim's content into a new file called ~/.vim/colors, instead of creating the directory.

Can't install zoomwin

I could not install zoomwin.
Archive::Any 's version is 0.0932.

$ vimana install zoomwin
Canonical name: zoomwin
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Invalid header block at offset unknown at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
No data could be read from file at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 35
Can't call method "extract" on an undefined value at /home/tyru/local/lib/perl5/Archive/Any/Plugin/Tar.pm line 36.

Use Pathogen

Instead of installing plugins on .vim itself, install pathogen and install plugins inside .vim/bundles – it's easier to maintain and easier to uninstall.

Can't find python.vim, script id=30

Can't find vim script id = 30, python.vim. Actually, it's not in the index file. I tried the page http://www.vim.org/scripts/script_search_results.php?keywords=&order_by=creation_date&direction=ascending&show_me=3000
The python.vim was there, I don't know why it's gone in the index file after parse. Haven't dug too deep, not familiar with perl.

Script dependencies

Support tags like:

  " Script depends:  liba.vim , libb.vim,  git:git://github.com/path/to/repo.git , http:// ..... blah..

recommended settings

scripts can have its own recommended settings to be appended to vimrc file.

could be embedded in vim script by:

     " Script Settings: 
     "    set ...blah
     "    nmap ..........

or in a file named "vim_settings" or something ,