Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.jjui.enable

Whether to enable jjui - A terminal user interface for jujutsu.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.jjui.package

The jjui package to use.

Type: null or package

Default:

pkgs.jjui

Declared by:

programs.jjui.configDir

The directory to contain jjui configuration files.

Type: string

Default:

${config.xdg.configHome}/jjui

Example:

${config.home.homeDirectory}/.jjui

Declared by:

programs.jjui.configLua

The content of the (config.programs.jjui.configDir)/config.lua file, set either by specifying a path to a Lua file or by providing a multi-line Lua string.

See https://idursun.github.io/jjui/customization/config-lua/ for documentation on Lua support.

Use the option plugins to configure Lua plugins imported here.

Type: null or absolute path or strings concatenated with “\n”

Default:

null

Example:

''
  local foo = require("plugins.foo")
  local bar = require("plugins.bar")
  
  function setup(config)
    foo.setup(config)
    bar.setup("#5B8DEF", config)
  
    config.action("show diff in diffnav", function()
      local change_id = context.change_id()
      if not change_id or change_id == "" then
        flash({ text = "No revision selected", error = true })
        return
      end
  
      exec_shell(string.format("jj diff -r %q --git --color always | diffnav", change_id))
    end, { desc = "show diff in diffnav", key = "ctrl+d", scope = "revisions" })
  end
''

Declared by:

programs.jjui.plugins

Lua plugins, one per attribute. The <name> attribute will become the plugin name, and the <value> attribute is a path to a Lua file or a multi-line Lua string. Each attribute will be linked to (config.programs.jjui.configDir)/plugins/<name>.lua with <value> content.

See https://idursun.github.io/jjui/customization/config-lua/ for documentation on Lua support.

Remember to import the defined plugins in the configLua option.

Type: attribute set of (absolute path or strings concatenated with “\n”)

Default:

{ }

Example:

{
  foo = ./foo.lua;
  bar = /* lua */ '\'
    local M = {}

    function M.setup(primary, config)
      config.ui = config.ui or {}
      config.ui.colors = config.ui.colors or {}

      config.ui.colors.title = { fg = primary, bold = true }
    end

    return M
  '\';
}

Declared by:

programs.jjui.settings

Options to add to the (config.programs.jjui.configDir)/config.toml file. See https://idursun.github.io/jjui/customization/config-toml/ for options.

Type: TOML value

Default:

{ }

Example:

{
  revisions = {
    revset = "";
    template = "builtin_log_compact";
  };
}

Declared by: