plugins.kulala.settings

Options provided to the require('kulala').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  additional_curl_options = { };
  debug = false;
  default_env = "dev";
  default_view = "body";
  environment_scope = "b";
  icons = {
    inlay = {
      done = "✅";
      error = "❌";
      loading = "⏳";
    };
    lualine = "🐼";
  };
}

Declared by:

plugins.kulala.settings.certificates

Configures SSL/TLS certificates.

Type: null or (attribute set of (anything or raw lua code))

Default: null

Plugin default: { }

Declared by:

plugins.kulala.settings.contenttypes

Defines formatters and path resolvers for specific content types.

Type: null or (attribute set of (anything or raw lua code))

Default: null

Plugin default:

{
  "application/json" = {
    formatter = [
      "jq"
      "."
    ];
    ft = "json";
    pathresolver = {
      __raw = "require('kulala.parser.jsonpath').parse";
    };
  };
  "application/xml" = {
    formatter = [
      "xmllint"
      "--format"
      "-"
    ];
    ft = "xml";
    pathresolver = [
      "xmllint"
      "--xpath"
      "{{path}}"
      "-"
    ];
  };
  "text/html" = {
    formatter = [
      "xmllint"
      "--format"
      "--html"
      "-"
    ];
    ft = "html";
    pathresolver = [ ];
  };
}

Declared by:

plugins.kulala.settings.curl_path

Path to the cURL binary. Set this if cURL is installed in a non-standard location.

Type: null or string or raw lua code

Default: null

Plugin default: "curl"

Declared by:

plugins.kulala.settings.debug

Enables or disables debug mode.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.kulala.settings.default_env

Sets the default environment for requests. Common options are “dev”, “test”, or “prod”.

Type: null or string or raw lua code

Default: null

Plugin default: "dev"

Declared by:

plugins.kulala.settings.default_view

Sets the default view mode for responses. Options are “body”, “headers”, or “headers_body”.

Type: null or one of “body”, “headers”, “headers_body” or raw lua code

Default: null

Plugin default: "body"

Declared by:

plugins.kulala.settings.default_winbar_panes

Specifies which panes are displayed by default in the winbar.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default:

[
  "body"
  "headers"
  "headers_body"
]

Declared by:

plugins.kulala.settings.disable_script_print_output

Disables immediate printing of script outputs; outputs will still be written to disk.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.kulala.settings.display_mode

Defines how the request/response is displayed. Options are “split” or “float”.

Type: null or one of “split”, “float” or raw lua code

Default: null

Plugin default: "split"

Declared by:

plugins.kulala.settings.environment_scope

Sets the scope for environment and request variables. Options are “b” (buffer) or “g” (global).

Type: null or one of “b”, “g” or raw lua code

Default: null

Plugin default: "b"

Declared by:

plugins.kulala.settings.icons

Sets default icons for loading states and lualine.

Type: null or (attribute set of (anything or raw lua code))

Default: null

Plugin default:

{
  inlay = {
    done = "✅";
    error = "❌";
    loading = "⏳";
  };
  lualine = "🐼";
}

Declared by:

plugins.kulala.settings.scratchpad_default_contents

Default contents for the scratchpad feature.

Type: null or (list of (anything or raw lua code))

Default: null

Plugin default:

[
  "@MY_TOKEN_NAME=my_token_value"
  ""
  "# @name scratchpad"
  "POST https://httpbin.org/post HTTP/1.1"
  "accept: application/json"
  "content-type: application/json"
]

Declared by:

plugins.kulala.settings.show_icons

Determines where icons are displayed relative to requests. Options are "on_request", "above_request", "below_request", or {__raw = "nil";} to disable.

Type: null or one of “on_request”, “above_request”, “below_request” or raw lua code

Default: null

Plugin default: "on_request"

Declared by:

plugins.kulala.settings.split_direction

Defines the direction of the split window. Options are “vertical” or “horizontal”.

Type: null or one of “vertical”, “horizontal” or raw lua code

Default: null

Plugin default: "vertical"

Declared by:

plugins.kulala.settings.vscode_rest_client_environmentvars

Enables reading environment variables from VSCode’s REST client.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.kulala.settings.winbar

Enables or disables the winbar for displaying request status.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by: