Skip to content

Network

All settings found under the network key.

local plugin = require('distant')
plugin:setup({
   network = {}
})

network.private

If true, will create a private network for all operations associated with a singular neovim instance. Use this option if you want to avoid clashing with a pre-existing distant manager.

Boolean representing whether or not to use a private network. [default: false]

Example
{
    network = {
        private = false
    }
}

network.timeout.max

Maximum time to wait for requests to a remote server to complete.

Integer representing time in milliseconds. Set to 0 to disable. [default: 15 seconds]

Example
{
    network = {
        timeout = {
            max = 15000
        }
    }
}

network.timeout.interval

Time to wait inbetween checks to see if a request timed out.

Integer representing time in milliseconds. [default: 256]

Example
{
    network = {
        timeout = {
            interval = 256
        }
    }
}

network.windows_pipe

Custom name to use for the Windows pipe that the distant manager uses for communication with neovim.

String representing the name of the local Windows pipe. [default: nil]

Example
{
    network = {
        windows_pipe = 'my-pipe'
    }
}

network.unix_socket

Custom path to a Unix domain socket that the distant manager uses for communication with neovim.

String representing the path to the Unix domain socket. [default: nil]

Example
{
    network = {
        unix_socket = '/path/to/distant.sock'
    }
}