Schema Docs

A list of variable mappings. This can be useful where variable definitions rely on each other. By using a list, you can control the sequence in which variables are defined.

Each item of this array must be:

root adapters additionalProperties allOf item 1 variables oneOf item 1 variables-mapping

Type: object
Same definition as adapters_additionalProperties_allOf_i1_variables_oneOf_i0

root adapters additionalProperties allOf item 2

Type: object

root adapters additionalProperties allOf item 2 name

Type: string

Passed to the adapter in the initialization request. Some adapters are particularly picky about what value goes here. Usually it can be omitted and Vimspector will send a generic value

root adapters additionalProperties allOf item 2 configuration

Type: object

Base debug configuration. Can be used to set default values for all debug configurations. When reading individual debug configurations from 'configurations', those configurations are merged with this object. Definitions in the debug configuration override anything in this object. Typical usage for this is to set the 'type' parameter, which some debug adapters are very picky about, or to set e.g. the path to an underlying debugger.

root adapters additionalProperties allOf adapter-launchattach

Type: object

root adapters additionalProperties allOf item 3 launch

root adapters additionalProperties allOf item 3 launch allOf adapter-remote

Type: object

root adapters additionalProperties allOf item 3 launch allOf item 0 remote

Configures how Vimspector will marshal remote debugging requests. When remote debugging, Vimspector will either ssh to 'account'@'host', docker exec -it to 'container' or work locally and run 'pidCommand', 'attachCommands', 'runCommands', etc. based on the 'remote-command' option in the debug configuration. If 'remote-command' is 'launch', it runs 'runCommand(s)', otherwise (it's 'attach') vimspector runs 'pidCommand', followed by 'attachCommand(s)'.Then it starts up the debug adapter with the debug configuration as normal. Usually this is configured with an 'attach' request (whether we remotely 'launched' or not). Once the initialization exchange is complete, Vimspector runs the optional 'initCompleteCommand' which can be used to force the application to break, e.g. by sending it SIGINT. This is required on some platforms which have buggy gdbservers (for example)

All of

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 0

Any of

Option 1
Option 2

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 0 anyOf item 0

One of

Option 1
Option 2

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 0 anyOf item 0 oneOf item 0

Type: object

The following properties are required:

host

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 0 anyOf item 0 oneOf item 1

Type: object

The following properties are required:

container

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 0 anyOf item 1

Must not be:

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 0 anyOf item 1 not

Type: object

The following properties are required:

host
container

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 1

Type: object

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 1 account

Type: string

Remote account name used when ssh'ing. Defaults to the current user account.

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 1 host

Type: string

Name of the remote host to connect to (via passwordless SSH).

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 1 container

Type: string

Name or container id of the docker run container to connect to (via docker exec). Note the container must already be running (Vimspector will not start it) and it must have the port forwarded to the host if subsequently connecting via a port (for example docker run -p 8765:8765 -it simple_python).

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2

One of

Option 1
Option 2

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 0

All of

Requirement 1
Requirement 2

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 0 allOf item 0

One of

Option 1
Option 2

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 0 allOf item 0 oneOf item 0

Type: object

The following properties are required:

attachCommand

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 0 allOf item 0 oneOf item 1

Type: object

The following properties are required:

attachCommands

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 0 allOf item 1

Type: object

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 0 allOf item 1 initCompleteCommand

Type: array of string

For remote-attach. Remote command to execute after initialization of the debug adapter. Can be used to work around buggy attach behaviour on certain platforms (advanced usage). Can contain the special token %PID% which is replaced with the PID returned by 'pidCommand'

Each item of this array must be:

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 0 allOf item 1 initCompleteCommand initCompleteCommand items

Type: string

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 0 allOf item 1 pidCommand

Type: array of string

Required for remote-attach. Remote command to execute to return the PID to attach to.

Each item of this array must be:

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 0 allOf item 1 pidCommand pidCommand items

Type: string

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 0 allOf item 1 attachCommands

Type: array of array

For remote-attach. List of commands to execute remotely to set up the attach. Can contain the special token %PID% which is replaced with the PID returned by the remote 'pidCommand'.

Each item of this array must be:

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 0 allOf item 1 attachCommands attachCommands items

Type: array of string

Each item of this array must be:

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 0 allOf item 1 attachCommands attachCommands items attachCommands items items

Type: string

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 0 allOf item 1 attachCommand

Type: array of string

A single command to execute for remote-attach. Like attachCommands but for a single command. If attachCommands is supplied, this is not used.

Each item of this array must be:

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 0 allOf item 1 attachCommand attachCommand items

Type: string

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 1

All of

Requirement 1
Requirement 2

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 1 allOf item 0

One of

Option 1
Option 2

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 1 allOf item 0 oneOf item 0

Type: object

The following properties are required:

runCommand

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 1 allOf item 0 oneOf item 1

Type: object

The following properties are required:

runCommands

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 1 allOf item 1

Type: object

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 1 allOf item 1 runCommands

Type: array of array

For remote-launch. List of commands to execute remotely to set up the launch. An entry in the array can be the special token '%CMD%' which is replaced with the evaluated 'remote-cmdLine' value in the debug configuration. This is useful to parameterize launcging remotely under something like gdbserver.

Each item of this array must be:

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 1 allOf item 1 runCommands runCommands items

Type: array of string

Each item of this array must be:

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 1 allOf item 1 runCommands runCommands items runCommands items items

Type: string

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 1 allOf item 1 runCommand

Type: array of string

A single command to execute for remote-launch. Like runCommands but for a single command.

Each item of this array must be:

root adapters additionalProperties allOf item 3 launch allOf item 0 remote allOf item 2 oneOf item 1 allOf item 1 runCommand runCommand items

Type: string

root adapters additionalProperties allOf item 3 launch allOf item 1

Type: object

root adapters additionalProperties allOf item 3 launch allOf item 1 delay

Type: string

A time in the format understood by :help :sleep to wait after running the attachCommand(s)

root adapters additionalProperties allOf item 3 attach

All of

adapter-remote
Requirement 2

root adapters additionalProperties allOf item 3 attach allOf adapter-remote

Type: object
Same definition as adapters_additionalProperties_allOf_i3_launch_allOf_i0

root adapters additionalProperties allOf item 3 attach allOf item 1

Type: object

root adapters additionalProperties allOf item 3 attach allOf item 1 pidSelect

Type: enum (of string)

Must be one of:

"ask"
"none"

root adapters additionalProperties allOf item 3 attach allOf item 1 pidProperty

Type: string

The launch config property which the PID should be injected into. Required when 'pidSelect' is 'ask'.

root adapters additionalProperties allOf item 3 attach allOf item 1 delay

Type: string

A time in the format understood by :help :sleep to wait after running the attachCommand(s)

root adapters additionalProperties allOf item 4

Any of

root adapters additionalProperties allOf item 4 anyOf item 0

Type: object

The following properties are required:

command

root adapters additionalProperties allOf item 4 anyOf item 1

Type: object

The following properties are required:

port

root adapters additionalProperties allOf item 4 anyOf item 2

Type: object

The following properties are required:

command
port

root adapters additionalProperties allOf item 4 anyOf item 2 tty

Type: boolean

Set to True to launch 'command' in a terminal. Only valid when both 'command' and 'port' are supplied.

root adapters additionalProperties allOf item 4 anyOf item 3

Type: object

The following properties are required:

extends

root adapters additionalProperties allOf item 5

Type: object

root adapters additionalProperties allOf item 5 host

Type: string Default: "127.0.0.1"

Connect to this host in multi-session mode

root adapters additionalProperties allOf item 5 port

If supplied, indicates that a socket connection should be made to this port on 'host'. If the value is 'ask', then the user is asked to enter the port number to connect to.

One of

Option 1
Option 2

root adapters additionalProperties allOf item 5 port oneOf item 0

Type: string

root adapters additionalProperties allOf item 5 port oneOf item 1

Type: integer

root adapters additionalProperties allOf item 5 extends

Type: string

Name of another adapter from which to inherit all properties

root adapters additionalProperties allOf item 5 sync_timeout

Type: number

Timeout for synchronous requests to the adapter (in ms). Default is 5000

root adapters additionalProperties allOf item 5 async_timeout

Type: number

Timeout for asynchronous requests to the adapter (in ms). Default is 15000

root adapters additionalProperties allOf item 5 cwd

Type: string

Directory in which to start the adapter

adapters

Additional Properties

All of

variables

One of

Additional Properties

One of

shell Required

cwd

env

Each item of this array must be:

name

configuration

launch

All of

remote

All of

Any of

One of

The following properties are required:

The following properties are required:

Must not be:

The following properties are required:

account

host

container

One of

All of

One of

The following properties are required:

The following properties are required:

initCompleteCommand

Each item of this array must be:

pidCommand

Each item of this array must be:

attachCommands

Each item of this array must be:

Each item of this array must be:

attachCommand

Each item of this array must be:

All of

One of

The following properties are required:

The following properties are required:

runCommands

Each item of this array must be:

Each item of this array must be:

runCommand

Each item of this array must be:

delay

attach

All of

pidSelect Required

Must be one of:

pidProperty

delay

Any of

The following properties are required:

The following properties are required:

The following properties are required:

tty

The following properties are required:

host

port

One of

extends

sync_timeout

async_timeout

cwd