https://github.com/gennaro-tedesco/nvim-dvc

The long awaited dvc plugin for neovim
https://github.com/gennaro-tedesco/nvim-dvc

dvc lua neovim

Last synced: 30 days ago
JSON representation

The long awaited dvc plugin for neovim

• Host: GitHub
• URL: https://github.com/gennaro-tedesco/nvim-dvc
• Owner: gennaro-tedesco
• Created: 2021-11-24T16:22:05.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2021-12-14T18:14:23.000Z (almost 3 years ago)
• Last Synced: 2024-08-04T01:12:50.506Z (4 months ago)
• Topics: dvc, lua, neovim
• Language: Lua
• Homepage:
• Size: 18.6 KB
• Stars: 26
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  


  nvim-dvc

  






  

  



The DVC plugin for neovim




  Installation •

  Usage •

  Customisation •

  Feedback



If only one could interact with [DVC](https://dvc.org) from within neovim. Oh wait, `nvim-dvc` does just that!

## Installation

Install it using your favourite plugin manager; for instance if you are using vim-plug

```

Plug 'gennaro-tedesco/nvim-dvc'

```

Notice that this plugin makes use of bash core utils and `jq` internally (to parse DVC outputs), so it is recommended to have them installed.

## Usage

`nvim-dvc` populates the location list with DVC stages and metrics files for easy access to models performances, or it enables to execute pipelines making use of prompt autocompletion, or it quickly opens up the DVC configurations. See demo below for a quick tour:

![demo](https://user-images.githubusercontent.com/15387611/144018897-5432fec1-c0a7-4329-93ae-9923f8b56f10.gif)

Default commands:

| command            | autocompletion | description

|:------------------ |:---------------|:-------------

|`DVCStages`         | ``        | populate the location list with DVC stages

|`DVCMetrics`        | No             | populate the location list with DVC metrics files

|`DVCRepro`          | ``        | prompt autocompletion menu (after ``) and execute stage

|`DVCFiles`          | No             | populate the location list with all DVC tracked files

|`DVCConfig`         | No             | open `/.dvc/config` for editing

The commands usage is self-explanatory, just invoke them and sit back; however, see `:h dvc-usage` (or `:h `)for further help.

## Customisation

If you prefer to populate the quickfix window rather than the location list simply override

```

lua require('nvim-dvc.config').use_quickfix = true

```

## Feedback

Do not forget that the best way to browse metrics files and json in general is [nvim-jqx](https://github.com/gennaro-tedesco/nvim-jqx).

If you find this plugin useful consider awarding it a ⭐, it is a great way to give feedback! Otherwise, any additional suggestions or merge request is warmly welcome!