plugins.octo.settings

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

Type: attribute set of anything

Default: { }

Example:

{
  mappings = {
    file_panel = {
      select_prev_entry = "[q";
    };
    issue = {
      react_heart = "<leader>rh";
    };
  };
  mappings_disable_default = true;
  ssh_aliases = {
    "github.com-work" = "github.com";
  };
}

Declared by:

plugins.octo.settings.enable_builtin

Shows a list of builtin actions when no action is provided.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.octo.settings.default_remote

Order to try remotes

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

Default: null

Plugin default:

[
  "upstream"
  "origin"
]

Declared by:

plugins.octo.settings.gh_env

Extra environment variables to pass on to GitHub CLI, can be a table or function returning a table.

Type: null or (attribute set)

Default: null

Plugin default: { }

Declared by:

plugins.octo.settings.github_hostname

Github Enterprise host.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.octo.settings.left_bubble_delimiter

Bubble delimiter.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.octo.settings.picker

Picker to use.

Type: null or one of “telescope”, “fzf-lua” or raw lua code

Default: null

Plugin default: "telescope"

Declared by:

plugins.octo.settings.reaction_viewer_hint_icon

Marker for user reactions.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.octo.settings.right_bubble_delimiter

Bubble delimiter.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.octo.settings.snippet_context_lines

Number of lines around commented lines.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 4

Declared by:

plugins.octo.settings.ssh_aliases

SSH aliases.

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

Default: null

Plugin default: { }

Declared by:

plugins.octo.settings.timeline_indent

Timeline indentation.

Type: null or string or raw lua code

Default: null

Plugin default: "2"

Declared by:

plugins.octo.settings.timeline_marker

Timeline marker.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.octo.settings.timeout

Timeout for requests between the remote server.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 5000

Declared by:

plugins.octo.settings.use_local_fs

Use local files on right side of reviews.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.octo.settings.user_icon

User Icon.

Type: null or string or raw lua code

Default: null

Plugin default: " "

Declared by: