Lua

The distant plugin comes with a vast API available in Lua. All of the public API methods are accessible through the top-level plugin object made available from requiring distant:

local plugin = require('distant')

• Initialization

  ---

  See how the plugin is initialized and how you can verify the plugin is ready to be used.

  Initialization

• Connection Management

  ---

  Manage connections directly in Lua.

  Connection Management

• Settings

  ---

  Access and modify settings tied to the plugin.

  Settings

• API

  ---

  Explore the full power of distant through a Lua interface to its API.

  API

• Buffers

  ---

  Access remote-specific information tied to buffers managed by this plugin.

  Buffers

• Editor

  ---

  Directly invoke editor-specific functions.

  Editor

• Events

  ---

  Tap into the events exposed by the plugin for greater insight and control.

  Events

• Shells

  ---

  Spawn shells to remote machines directly using Lua.

  Shells

• Wrapping Commands

  ---

  Wrap commands to be executed on the remote machine, enabling easier integration with other plugins that take command strings.

  Wrapping commands

• Version

  ---

  Understand the version of the plugin being used from Lua.

  Version

• Utilities

  ---

  Check out additional utility functions exposed by the plugin.

  Utilities