https://github.com/nat-418/scamp.nvim

Neovim plugin to remotely edit files over SSH
https://github.com/nat-418/scamp.nvim

Last synced: 8 days ago
JSON representation

Neovim plugin to remotely edit files over SSH

• Host: GitHub
• URL: https://github.com/nat-418/scamp.nvim
• Owner: nat-418
• License: 0bsd
• Created: 2022-11-07T19:07:34.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-23T07:51:30.000Z (8 months ago)
• Last Synced: 2024-10-31T19:37:39.821Z (13 days ago)
• Language: Lua
• Size: 17.6 KB
• Stars: 36
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# scamp 🐕

![Semantic Versioning 2.0.0]

![Conventional Commits 1.0.0]

Scamp is a simple Neovim plugin for remotely editing files.

Scamp uses SCP and assumes key-based SSH authentication.

Scamp is designed for people who do not use Netrw, e.g.:

```lua

-- ~/.config/nvim/init.lua

vim.g.loaded_netrwPlugin = 1

vim.g.loaded_netrw       = 1

```

## Installing

```sh

$ git clone --depth 1 https://github.com/nat-418/scamp.nvim ~/.local/share/nvim/site/pack/scamp/start/scamp.nvim

```

## Configuration

Add the following to your configuration:

```lua

-- ~/.config/nvim/init.lua

require('scamp').setup()

```

This setup function accepts a table of configuration options.

Here are the defaults:

```lua

-- ~/.config/nvim/init.lua

require('scamp').setup({

  -- see man(5) ssh_config for more control options

  scp_options = {

    'ConnectTimeout=5'

  }

})

```

## Usage

Scamp hooks into read and write events, so you can simply

`:edit scp://[email protected]/whatever` and `:write` normally.

[Conventional Commits 1.0.0]: https://flat.badgen.net/badge/Conventional%20Commits/1.0.0/

[Semantic Versioning 2.0.0]:  https://flat.badgen.net/badge/Semantic%20Versioning/2.0.0/