Repository files navigation

vimwiki-cli is a command-line interface toVimwiki, a plugin for theVim text editor. It provides a front-end for interactive editor commandsand can be used to automate repetitive tasks such as rebuilding tag metadata andgenerating links, all from the command line.

vimwiki-cli is available onPyPI and can be installed locally using thePython Package Installer:

$ python -m pip install --user vimwiki-cli

Once installed, issuevimwiki --help to see usage.

For most installations no configuration is needed, however several environmentvariables are available to modify default behavior without the need to passglobal options on the command line:

Each CLI command corresponds to one or more Ex commands executed in the editor.The following table details the mapping between these commands:

Shell completion is available forbash,fish, andzsh shells. To generatean activation script, issue:

$ env _VIMWIKI_COMPLETE=source_$(basename $SHELL) vimwiki >/path/to/vimwiki-complete.sh

Once generated, the activation script may be sourced directly or from the shellstartup file to provide completion:

$ . /path/to/vimwiki-complete.sh

For wikis managed with Git, a pre-commit hook script is available that executesnon-interactive commands to rebuild tag metadata and generate links beforecommit.

The pre-commit hook relies on the following configuration options:

For example, to configure the hook to rebuild tag metadata and generate taglinks in theTags page before commit, issue:

$ git config vimwiki.taglinkspage Tags$ git config vimwiki.generatetaglinks true$ git config vimwiki.rebuildtags true

To enable the hook, copy or linkpre-commit.sh to.git/hooks/pre-commitin the wiki directory. Alternatively, ifpre-commit is installed, add apre-commit configuration file,.pre-commit-config.yaml and runpre-commit autoupdate to enable the latest version of the hook.

# See https://pre-commit.com for more information# See https://pre-commit.com/hooks.html for more hooksrepos:  -repo:https://github.com/sstallion/vimwiki-clirev:v1.1.0hooks:      -id:vimwiki-cli

Pull requests are welcome! SeeCONTRIBUTING.md for more details.

Source code in this repository is licensed under a Simplified BSD License. SeeLICENSE for more details.