Skip to content

Modules

Jump to bottom
readf0x edited this page Dec 26, 2024 · 2 revisions

General Options

This was automatically generated from the module definitions using ChatGPT, I apologize for any errors, but I was too busy with the code itself to write this out manually.

int_modules

  • Description: Specifies the active modules in the prompt.
  • Type: Array of strings.
  • Default: ["direnv", "nix", "visym", "error", "dir", "git", "jobs"]

int_right_modules

  • Description: Specifies the modules to display on the right side of the prompt.
  • Type: Array of strings.
  • Default: ["time"]

int_kitty_integration

  • Description: Enables Kitty terminal integration.
  • Type: Boolean.
  • Default: "false"

int_prompt

  • Description: Customizes the prompt structure.
  • Type: Array of strings.
  • Default: ["⌠", "⎮", "⌡", "∫"]

Direnv

int_direnv_format()

  • Description: Defines the format for the Direnv module in the prompt.
  • Default: Displays "⌁" in yellow (%F{11}).

Nix

int_nix_icons

  • Description: Icons used in the Nix module.
  • Type: Array of strings.
  • Default: ["❄", "\uf313"]

int_nix_color

  • Description: Colors associated with the Nix module icons.
  • Type: Array of strings.
  • Default: ["14", "13"]

Vim

int_vim_indicators

  • Description: Customizes the Vim mode indicators.
  • Type: Array of strings (insert, visual, v-line, normal).
  • Default:
    • Insert: "○"
    • Visual: "◒"
    • V-line: "◐"
    • Normal: "●"

int_vim_colors

  • Description: Colors associated with Vim modes.
  • Type: Array of strings.
  • Default:
    • Insert: "10"
    • Visual: "13"
    • V-line: "13"
    • Normal: "9"

Error

int_error_format()

  • Description: Formats the error codes in the prompt.
  • Type: Function.
  • Default:
    • 1: "✘" in red.
    • 2/127: "?" in yellow.
    • 126: "⚠" in red.
    • 130: "☠" in white.
    • 148: "✱" in magenta.
    • Default: "✘" in red.

Directory

int_dir_format()

  • Description: Formats the directory path in the prompt.
  • Type: Function.
  • Default: Replaces the home directory with ~ in the path.

int_dir_color

  • Description: The color used for the directory path in the prompt.
  • Type: String.
  • Default: "12"

Git

int_git_icons

  • Description: Icons used in the Git module.
  • Type: Array of strings.
  • Default:
    • Branch: "⎇"
    • Conflict: "✘"
    • Added: "+"
    • Push: "↑"
    • Pull: "↓"

int_git_colors

  • Description: Colors associated with the Git module icons.
  • Type: Array of strings.
  • Default:
    • Branch: "11"
    • Conflict: "9"
    • Added: "11"
    • Push: "14"
    • Pull: "14"

Jobs

int_jobs_icon

  • Description: Icon used to indicate background jobs.
  • Type: String.
  • Default: "⚙"

int_jobs_color

  • Description: Color used for the jobs indicator.
  • Type: String.
  • Default: "13"

Time

int_time_format

  • Description: Specifies the format for the time display in the prompt.
  • Type: String.
  • Default: "%T"

Uptime

int_uptime_icon

  • Description: Icon used for displaying system uptime.
  • Type: String.
  • Default: "⏲"

int_uptime_color

  • Description: Color used for the uptime icon.
  • Type: String.
  • Default: "12"

Battery

int_battery_icons

  • Description: Icons used for battery status.
  • Type: Array of strings.
  • Default: ["🗲", "\U000f0079"]

int_battery_color

  • Description: Color used for the battery status icons.
  • Type: String.
  • Default: "10"

SSH

int_ssh_format

  • Description: Defines the format for displaying SSH user and host.
  • Type: String.
  • Default: "%F{12}${USER}%F{13}@%F{14}${HOSTNAME}"
Clone this wiki locally