cylc.vim

Vim plugin providing support for the Cylc language.

Cylc Website | Contributing | Forum |

Installation

It is recommended to install as a Vim package (see :help packages):

mkdir -p ~/.vim/pack/vendor/start
cd ~/.vim/pack/vendor/start
git clone https://github.com/cylc/cylc.vim.git

Otherwise, use your favourite plugin manager.

Examples

Vim Plug:

" .vimrc
call plug#begin()
Plug 'vsherratt/cylc.vim'
call plug#end()

LazyVim:

-- lua/plugins/cylc.lua
return {
  -- add cylc.vim extension
  {
    "cylc/cylc.vim",
  }
}

Usage

Cylc syntax is linked to standard vim highlighting groups, so should already be consistent with any colour scheme.

Syntax-based folding is enabled; if you want to open files with folds initially open, then add the following line to your vimrc:

set foldlevelstart=99

Developing

Contributions welcome, read the contributing page and add yourself to the contributors list with your first pull request.

Copyright and Terms of Use

Copyright (C) 2008-2023 NIWA & British Crown (Met Office) & Contributors.