Skip to content

Manager

All settings found under the manager key.

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

manager.daemon

Indicate when neovim starts a manager if it will be run as a daemon, which will detach it from the neovim process. This means that the manager will persist after neovim itself exits.

Boolean representing whether or not to run the manager as a daemon. [default: false]

Example
{
    manager = {
        daemon = false
    }
}

manager.lazy

Indicate if the distant manager should be started eagerly or wait until the first time distant is needed in neovim.

Boolean representing whether or not to avoid starting the distant manager until first needed. [default: true]

Example
{
    manager = {
        lazy = true
    }
}

manager.log_file

Path where logging should be placed for the distant binary being used as the manager. This is only used when neovim starts the manager itself.

Path to the log file. [default: nil]

Example
{
    manager = {
        log_file = '/path/to/manager.log'
    }
}

manager.log_level

Logging level used for manager-based logging tied to the distant binary.

String representing the level. [default: info] Choices are off, error, warn, info, debug, trace.

Example
{
    manager = {
        log_level = 'info'
    }
}

manager.user

When neovim starts the distant manager, indicates whether to have the manager listen on a global or user-specific channel, which is dependent on the operating system.

Boolean representing whether or not to have the distant manager listen on a user-local channel. [default: false]

Example
{
    manager = {
        user = false
    }
}