cargo-make.json

title: Semantic Version

title: External Makefile

description: A potentially optional external makefile to extend

title: File Path

description: The path of the external makefile, relative to this file

description: If true, the external makefile is optional and does not need to exist

title: Script

title: Script Line

title: Script Lines

title: Script File

file: path/to/script

title: File Path

description: Scipt file name

default: path/to/script

description: If true, the `file` value is an absolute path

title: Split Script

description: Script content split to parts to enable a more fine tuned extension capability

initKeys: pre main post

title: Pre-Main Script

description: Pre-main script section

title: Main Script

description: Main script section

title: Post-Main Script

description: Post-main script section

title: List of Env Files

description: Load environment files

$ref: #/definitions/envfile

title: Env File

description: File containing environment variables and their values

profile: development

title: File Path

description: The path to the env file

description: The env file path and attributes

title: File Path

description: The path to the env file

title: Directory Path

description: The path base directory (relative paths are from this base path)

default: path/to/dir

title: Profile

description: The profile name this file is relevant to

default: development

examples: development production

title: Env Vars

description: Setup environment variables

title: Env Value

description: An environment variable value

title: Boolean

title: Integer

type: integer

title: String

title: Separator List

description: An array which will be joined with the `;` separator

title: Profile Env Vars

description: Profile dependent environment variables

$ref: #/definitions/env

title: Unset

description: Unsets environment variable

description: If true, the env variable will be unset, else ignored

title: Env Value Script

description: Provide environment variable via script

title: Script Lines

description: Enable multi-line values

title: Env Value Mapping

description: Environment variable value provided by decoding other values

required: source mapping

title: Env Var

description: The source environment variable (can be an env expression)

title: Env Value

description: The default value in case no decode mapping was found, if not provided it will default to the source value

title: Value Mapping

description: The decoding mapping from one value to another value

title: Env Value

title: Conditional Env Value

description: Environment variable value set if condition is met

title: Env Value

description: The value to set (can be an env expression)

description: Condition to evaluate to see whether to set the environment value or not

title: Env Value Glob

description: Environment value holding a list of paths based on given glob definitions

title: Glob Pattern

description: The glob used to fetch all paths

description: If true, include files in glob

description: If true, include directories in glob

title: Ignore Source

description: An ignore source that enables respecting ignore files from that source

default: git

title: Condition

description: Conditions allow you to evaluate at runtime if to run a specific task or not

title: Message

description: Message to display when the condition fails

title: List of Profiles

description: Profile names to match for the condition

title: Profile

description: Profile name

title: List of Platforms

description: Platform names to match for the condition

title: Platform

description: Platform name

enum: linux windows mac

title: List of Channels

description: Rust channels to match for the condition

title: Channel

description: Rust channel

enum: stable beta nightly

title: List of Env Vars

description: List of environment variables which must be defined

title: Env Var

description: Environment variable

title: List of Env Vars

description: List of environment variables which must not be defined

title: Env Var

description: Environment variable

title: List of Env Vars

description: List of environment variables which must be defined and must not be set to any of the following (case insensitive): `false`, `no`, `0`, or empty

title: Env Var

description: Environment variable

title: List of Env Vars

description: List of environment variables which must be defined and must be set to any of the following (case insensitive): `false`, `no`, `0`, or empty

title: Env Var

description: Environment variable

title: Env Vars

description: Map of environment variables that must be defined and equal to the provided values

title: Env Value

description: Environment value

title: Env Vars

description: Map of environment variables that must be defined and contain (case insensitive) the provided values

title: Env Value

description: Environment value

title: Rust Version Criteria

description: A definition of min, max and/or specific rust version

description: Minimum Rust version

$ref: #/definitions/semver

description: Maximum Rust version

description: Exact Rust version

title: List of Files

description: List of absolute path files to check they exist. Environment substitution is supported so you can define relative paths

title: File Path

description: File path

title: List of Files

description: List of absolute path files to check they do not exist. Environment substitution is supported so you can define relative paths

title: File Path

description: File path

title: Lists input and output globs

description: If any input file is newer than all output files, the condition is met. Environment substitution is supported so you can define relative paths

description: List of input globs

description: glob

description: List of output globs

description: glob

title: Task

description: A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

description: If true, it should ignore all data in the base task

title: Description

description: A description used to document the task

title: Category

description: Category name used to document the task

description: If true, the command/script of this task will not be invoked, but dependencies will be

description: If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

description: If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

title: Deprecation Message

title: Task Name

description: Extends the specified task as a base task

description: Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

description: Watch for file changes and invoke the task operation

title: Watch Options

description: Version of cargo-watch to install if it's not already installed

description: Postpone first run until a file changes

title: Glob Pattern

description: Ignore a glob/gitignore-style pattern while watching

description: Do not use .gitignore files while watching

title: List of Paths

description: List of files and folders to watch

title: Path

description: File or folder to watch

description: If provided all condition values must be met in order for the task to be invoked (will not stop dependencies)

title: Script

description: If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

description: If true, any error while executing the task will be printed but will not break the build

description: DEPRECATED, replaced with `ignore_errors`

description: The env files to setup before running the task commands

description: The env vars to setup before running the task commands

title: Directory Path

description: The working directory for the task to execute its command/script

title: Task Name

description: If defined, task points to another task and all other properties are ignored

title: Task Name

description: If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over `alias` on Linux)

title: Task Name

description: If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over `alias` on Windows)

title: Task Name

description: If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over `alias` on Mac)

description: Indicates the provided crate needs to be installed (if needed) before running the task

description: If set to false, will disable crate installation from the base task

title: Crate Name

description: Name of the crate to install

title: Crate Install Options

description: Instructions on how to install a crate

title: Crate Name

description: Name of the crate to install

title: Component Name

description: The component to install via rustup

title: File Name

description: The binary file name to be used to test if the crate is already installed

title: Args

description: Arguments used to check whether a crate or rustup component is installed.

description: Minimum version of installed crate before it needs to be reinstalled

description: Exact version of installed crate

title: Install Command

description: The alternative cargo install command to install the crate

title: Component Install Options

description: Instructions on how to install a rustup component

title: Component Name

description: The component to install via rustup

title: File Name

title: Args

title: Plugin Install Options

description: Instructions on how to install a cargo plugin

title: Crate Name

description: Name of the crate to install

title: Args

description: Additional cargo install args

description: Provided script will be executed before running the task

title: File Name

description: The command to execute for this task

title: Args

description: The args for the executed command

description: If `command` is not defined, but `script` is defined, the provided script will be executed

title: Script Runner

description: The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

title: Args

description: The script runner arguments before the script file path

title: File Extension

description: The file extension to use for the script

description: Run a task as a sub-task at the end of executing this task

title: Task Name

description: Name of the sub-task to execute

title: Task Name

description: Name(s) of the sub-task to execute

title: List of Task Names

title: Task Name

description: Fork the sub-task into a a new subprocess

description: Run tasks in parallel

title: Task Name

description: A task to run after all specified sub-tasks have completed

title: Conditional Tasks

description: Conditional sub-task selector

description: Sub-task routing information

title: Task Name

description: Name(s) of the sub-task to execute

title: List of Task Names

title: Task Name

description: Run tasks in parallel

title: Task Name

title: Script

description: If script exit code is not 0, the sub tasks will not be invoked

title: List of Tasks

description: A list of tasks to execute before this task

title: Task Name

description: The name of a task in this file

title: External Task

description: A task dependency potentially in another file

title: Task Name

description: The task name to execute

title: File Path

description: The path to the makefile the task resides in

title: Toolchain

description: The rust toolchain used to invoke the command or install the needed crates/components

description: Override task if runtime OS is Linux (takes precedence over alias)

description: Override task if runtime OS is Windows (takes precedence over alias)

description: Override task if runtime OS is Mac (takes precedence over alias)

description: A schema for cargo-make makefiles

title: Extend External Makefile

description: Extend an external makefile by importing its tasks and properties to this file. Paths are relative to this makefile

title: File Path

description: File path to external makefile relative to this file

title: External Makefile List

description: List of external makefiles to extend

title: Config

description: Configuration options for this makefile

description: If true, the default core tasks will not be loaded

description: If true, the Git related environment variables will not be loaded

description: If true, the rust related environment variables will not be loaded

description: If true, the current crate related environment variables will not be loaded

description: Options to modify all the core tasks

description: If true, all core tasks will be set to private (default false)

title: Namespace

description: If set to some value, all core tasks are modified to: `namespace::name`

title: Task Name

description: Init task name which will be invoked at the start of every run

title: Task Name

description: End task name which will be invoked at the end of every run

title: Task Name

description: The name of the task to run in case of any error during the invocation of the flow

title: Task Name

description: The name of the task which runs legacy migration flows

title: List of Profiles

description: Additional profile names to load

title: Profile

description: Additional profile name to load

description: Minimum cargo-make/makers version

description: The default value for the `workspace` value of tasks in this makefile

description: Set to true to reduce console output for non CI execution

description: Set to true to print time summary at the end of the flow

description: Automatically load cargo aliases as cargo-make tasks

title: Crate

description: The project information member (used by workspaces)

description: Invoked while loading the descriptor file but before loading any extended descriptor. Takes precedence over `load_script` if runtime OS is Linux.

description: Invoked while loading the descriptor file but before loading any extended descriptor. Takes precedence over `load_script` if runtime OS is Windows.

description: Invoked while loading the descriptor file but before loading any extended descriptor. Takes precedence over `load_script` if runtime OS is Mac.

description: The environment files to setup before running any tasks

title: List of Env Scripts

description: The environment scripts to execute after environment files and the env block. These scripts can be used to run anything needed before starting up the flow.

description: Env script

description: The environment variables to setup before running any tasks

description: Task definitions

title: Makefile.toml


$ref: #/definitions/JReleaserModel

type: string

enum: ALWAYS NEVER RELEASE PRERELEASE RELEASE_PRERELEASE SNAPSHOT

type: object

$ref: #/definitions/Active

$ref: #/definitions/ArticleAnnouncer

$ref: #/definitions/BlueskyAnnouncer

$ref: #/definitions/HttpAnnouncers

$ref: #/definitions/WebhooksAnnouncer

$ref: #/definitions/DiscordAnnouncer

description: announce.discord is deprecated since 1.4.0 and will be removed in 2.0.0

$ref: #/definitions/DiscourseAnnouncer

$ref: #/definitions/DiscussionsAnnouncer

$ref: #/definitions/GitterAnnouncer

description: announce.gitter is deprecated since 1.4.0 and will be removed in 2.0.0

$ref: #/definitions/GoogleChatAnnouncer

description: announce.googleChat is deprecated since 1.4.0 and will be removed in 2.0.0

$ref: #/definitions/HttpAnnouncerMap

$ref: #/definitions/HttpAnnouncer

$ref: #/definitions/LinkedinAnnouncer

$ref: #/definitions/SmtpAnnouncer

description: announce.mail is deprecated since 1.4.0 and will be removed in 2.0.0

$ref: #/definitions/MastodonAnnouncer

$ref: #/definitions/MattermostAnnouncer

description: announce.mattermost is deprecated since 1.4.0 and will be removed in 2.0.0

$ref: #/definitions/OpenCollectiveAnnouncer

$ref: #/definitions/SdkmanAnnouncer

$ref: #/definitions/SlackAnnouncer

$ref: #/definitions/TeamsAnnouncer

description: announce.teams is deprecated since 1.4.0 and will be removed in 2.0.0

$ref: #/definitions/TelegramAnnouncer

$ref: #/definitions/TwitterAnnouncer

$ref: #/definitions/WebhookAnnouncerMap

$ref: #/definitions/WebhookAnnouncer

$ref: #/definitions/ZulipAnnouncer

type: array

$ref: #/definitions/CommitAuthor

type: boolean

$ref: #/definitions/Properties

$ref: #/definitions/Icon

$ref: #/definitions/AppImageRepository

$ref: #/definitions/Screenshot

enum: NEVER ALWAYS WARN FORCE

$ref: #/definitions/Artifact

$ref: #/definitions/DistributionType

$ref: #/definitions/FileSet

$ref: #/definitions/Glob

$ref: #/definitions/ArchiveOptions

$ref: #/definitions/Platform

enum: ASC BAT CMD DEB DMG EXE JAR MSI NUGET PKG PS1 RPM SH SIG TAR TAR_BZ2 TAR_GZ TAR_XZ TAR_ZST TBZ2 TGZ TXZ ZIP ZST

description: JReleaser 1.7.0

enum: MSIX MSI APPX EXE ZIP INNO NULLSOFT WIX BURN PWA

enum: SEMVER CALVER CHRONVER JAVA_RUNTIME JAVA_MODULE CUSTOM


lazygit.json

$comment: This schema should be ported to https://github.com/jesseduffield/lazygit repository and be autogenerated

enum: black red green yellow blue magenta cyan white bold default reverse underline strikethrough

examples: <enter> <c-b> g

title: type

description:
A type
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#common-fields

enum: input confirm menu menuFromCommand

title: title

description:
A title
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#common-fields

title: key

description:
A key
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#common-fields

description:
UI settings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: gui

description:
Settings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: window size

description:
A window size
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

enum: normal half full

default: normal

title: scroll height

description:
A scroll height
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: scroll past bottom

description:
Whether to allow scrolling past bottom of the current window
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: side panel width

description:
A width of the current side panel
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

type: number

title: expand focused side panel

description:
Whether to expand focused side panel
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: main panel split mode

description:
A split mode of the current main panel
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

enum: horizontal flexible vertical

default: flexible

title: language

description:
A language
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

enum: auto en zh-CN zh-TW pl nl ja ko ru

default: auto

title: time format

description:
A time format
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: short time format

description:
A short time format
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: theme

description:
Settings of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: active border color

description:
Active border colors of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

description:
An active border color of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

$ref: #/definitions/color

title: inactive border color

description:
Inactive border colors of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

description:
An inactive border color of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: searching active border color

description:
Searching active border colors of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

description:
A searching active border color of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: options text color

description:
Option text colors of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

description:
An option text color of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: selected line bg color

description:
Selected line background colors of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

description:
A selected line background color of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: selected range bg color

description:
Selected range background colors of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

description:
A selected range background color of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: cherry picked commit bg color

description:
Cherry picked commit background colors of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

description:
A cherry picked commit background color of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: cherry picked commit fg color

description:
Cherry picked commit foreground colors of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

description:
A cherry picked commit foreground color of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: unstaged changes color

description:
Unstaged changes colors of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

description:
An unstaged changes color of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: default fg color

description:
Default foreground colors of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

description:
A default foreground color of the current theme
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: commit length

description:
Settings of the current commit length
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: show

description:
Whether to show the current commit length
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: mouse events

description:
Whether to enable mouse events
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: skip discard change warning

description:
Whether to disable change warning
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: skip stash warning

description:
Whether to disable stash warning
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: show file tree

description:
Whether to render render files in a tree format
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: show list footer

description:
Whether to show list footer
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: show random tip

description:
Whether to show a random tip
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: show branch commit hash

description:
Whether to show a branch commit hash
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: show bottom line

description:
Whether to show a bottom line unless there is an important information
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: show command log

description:
Whether to show command log
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: nerd fonts version

description:
A nerd font version
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: command log size

description:
A command log size
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: split diff

description:
Whether to skip diff
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

enum: auto always

title: skip reword in editor warning

description:
Whether to skip a confirmation before launching a reword editor
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: border

description:
A border style
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

enum: single double rounded hidden

default: single

title: animate explosion

description:
Whether to show explosion animation while nuking working tree
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: author colors

description:
Author colors
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color

title: author color

description:
An author color
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color

title: branch colors

description:
Branch colors
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color

title: branch color

description:
A branch color
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color

title: git

description:
Git settings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: paging

description:
Pager settings
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md

title: color argument

description:
A pager color argument
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md

enum: always never

default: always

title: use config

description:
Whether to use a config
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md

title: pager

description:
A pager
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md

examples: ydiff -p cat -s --wrap --width={{columnWidth}}

title: commit

description:
Commit settings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: sign off

description:
Whether to sign commits off
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: merging

description:
Merging settings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: manual commit

description:
Whether to use manual commits
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: arguments

description:
Additional CLI arguments for 'git merge'
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: log

description:
Log settings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: order

description:
A commit order
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

enum: date-order author-date-order topo-order default

default: topo-order

title: show graph

description:
Whether to show a graph
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

enum: always never when-maximised

default: when-maximised

title: show whole graph

description:
Whether to show the whole graph
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: skip hook prefix

description:
A prefix to skip
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

default: WIP

title: main branches

description:
Main branches
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

description:
A main branch
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

examples: main master

default: main master

title: auto fetch

description:
Whether to automatically fetch
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: auto refresh

description:
Whether to automatically refresh
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: fetch all

description:
Whether to fetch everything
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: branch log cmd

description:
A log command
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

default: git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --

title: all branches log cmd

default: git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium

title: override gpg

description:
Whether not to spawn a separate process while using GPG
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: disable force pushing

description:
Whether to disable force pushing
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: parse emoji

description:
Whether to parse emoji
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: diff context size

description:
how many lines of context are shown around a change in diffs
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: commit prefixes

description:
Commit prefixes
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix

title: repository path

description:
A repository path
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix

title: pattern

description:
A pattern
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix

title: replace

description:
A replacement
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix

title: os

description:
OS settings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#configuring-file-editing

title: copy to clipboard cmd

description:
A copy to clipboard command
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#configuring-file-editing

examples: printf "\033]52;c;$(printf {{text}} | base64)\a" > /dev/tty

title: edit preset

description:
An edit preset
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#configuring-file-editing

enum: vim nvim emacs nano vscode sublime bbedit kakoune helix xcode

title: edit

description:
An editor command
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#configuring-file-editing

examples: vim nvim emacs nano vscode sublime bbedit kakoune helix xcode

title: edit at line

description:
An editor command to open at specific line
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#configuring-file-editing

examples:
vim +{{line}} {{filename}}
nvim +{{line}} {{filename}}
emacs +{{line}} {{filename}}
nano +{{line}} {{filename}}
vscode -g {{filename}}:{{line}}
vscode --goto {{filename}}:{{line}}
sublime {{filename}}:{{line}}

title: edit at line and wait

description:
An editor command to open at specific line and wait
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#configuring-file-editing

examples: vscode --goto {{filename}}:{{line}} --wait

title: open

description:
An editor command for non-text files
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#configuring-file-editing

title: open link

description:
An open link
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: refresher

description:
Refresh settings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: refresh interval

description:
A file/submodule refresh interval in seconds
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: fetch interval

description:
A re-fetch interval in seconds
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: update

description:
Update settings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: method

description:
A method
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: days

description:
A day count
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: confirm on quit

description:
Whether to confirm on on quit
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: quit on top level return

description:
Whether to quit on 'esc' press while there is nothing to cancel/close
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: disable startup popups

description:
Whether to disable startup popups
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: not a repository

description:
An action for non-repositories
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: prompt to return from subprocess

description:
Whether to show confirmation on subprocess termination
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: keybinding

description:
Keybinding settings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: universal

description:
Universal keybindings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: quit

description:
A quit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: quit-alt1

description:
A quit-alt1 keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: return

description:
A return keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: quit without changing directory

description:
A quit without changing directory keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: toggle panel

description:
A toggle panel keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: prev item

description:
A previous item keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: next item

description:
A next item keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: prev item-alt

description:
A previous item-alt keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: next item-alt

description:
A next item-alt keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: prev page

description:
A previous page keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: next page

description:
A next page keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: goto top

description:
A goto top keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: goto bottom

description:
A goto bottom keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: scroll left

description:
A scroll left keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: scroll right

description:
A scroll right keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: prev block

description:
A previous block keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: next block

description:
A next block keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: prev block-alt

description:
A previous block-alt keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: next block-alt

description:
A next block-alt keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: jump to block

description:
A jump to block keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: next match

description:
A next match keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: prev match

description:
A previous match keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: option menu

description:
An option menu keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: option menu-alt1

description:
An option menu-alt1 keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: select

description:
A select keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: go into

description:
A go into keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: open recent repos

description:
An open recent repos keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: confirm

description:
A confirm keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: remove

description:
A remove keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: new

description:
A new keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: edit

description:
A edit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: open file

description:
An open file keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: scroll up main

description:
A scroll up main keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: scroll down main

description:
A scroll down main keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: scroll up main-alt1

description:
A scroll up main-alt1 keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: scroll down main-alt1

description:
A scroll down main-alt1 keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: scroll up main-alt2

description:
A scroll up main-alt2 keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: scroll down main-alt2

description:
A scroll down main-alt2 keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: execute custom command

description:
A execute custom command keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: create rebase options menu

description:
A create rebase options menu keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: push files

description:
A push files keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: pull files

description:
A pull files keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: refresh

description:
A refresh keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: create patch options menu

description:
A create patch options menu keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: next tab

description:
A next tab keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: prev tab

description:
A previous tab keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: next screen mode

description:
A next screen mode keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: prev screen mode

description:
A previous screen mode keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: undo

description:
An undo keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: redo

description:
A redo keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: filtering menu

description:
A filtering menu keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: diffing menu

description:
A diffing menu keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: diffing menu-alt

description:
A diffing menu-alt keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: copy to clipboard

description:
A copy to clipboard keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: submit editor text

description:
A submit editor text keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: extras menu

description:
A extras menu keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: toggle whitespace in diff view

description:
A toggle whitespace in diff view keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: increase context in diff view

description:
A increase context in diff view keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: decrease context in diff view

description:
A decrease context in diff view keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: status

description:
Status keybindings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: check for update

description:
A check for update keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: recent repos

description:
A recent repos keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: files

description:
File keybindings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: commit changes

description:
A commit changes keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: commit changes without hook

description:
A commit changes without hook keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: amend last commit

description:
A amend last commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: commit changes with editor

description:
A commit changes with editor keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: ignore file

description:
A ignore file keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: refresh files

description:
A refresh files keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: stash all changes

description:
A stash all changes keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: view stash options

description:
A view stash options keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: toggle staged all

description:
A toggle staged all keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: view reset options

description:
A view reset options keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: fetch

description:
A fetch keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: toggle tree view

description:
A toggle tree view keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: open merge tool

description:
A open merge tool keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: open status filter

description:
A open status filter keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: branches

description:
Branch keybindings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: create pull request

description:
A create pull request keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: view pull request options

description:
A view pull request options keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: checkout branch by name

description:
A checkout branch by name keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: force checkout branch

description:
A force checkout branch keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: rebase branch

description:
A rebase branch keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: rename branch

description:
A rename branch keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: merge into current branch

description:
A merge into current branch keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: view git flow options

description:
A view git flow options keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: fast forward

description:
A fast forward keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: create tag

description:
A create tag keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: push tag

description:
A push tag keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: set upstream

description:
A set upstream keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: fetch remote

description:
A fetch remote keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: commits

description:
Commit keybindings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: squash down

description:
A squash down keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: rename commit

description:
A rename commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: rename commit with editor

description:
A rename commit with editor keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: view reset options

title: mark commit as fixup

description:
A mark commit as fixup keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: create fixup commit

description:
A create fixup commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: squash above commits

description:
A squash above commits keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: move down commit

description:
A move down commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: move up commit

description:
A move up commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: amend to commit

description:
A amend to commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: pick commit

description:
A pick commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: revert commit

description:
A revert commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: cherry pick copy

description:
A cherry pick copy keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: cherry pick copy range

description:
A cherry pick copy range keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: paste commits

description:
A paste commits keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: tag commit

description:
A tag commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: checkout commit

description:
A checkout commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: reset cherry pick

description:
A reset cherry pick keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: copy commit message to clipboard

description:
A copy commit message to clipboard keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: open log menu

description:
A open log menu keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: view bisect options

description:
A view bisect options keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: stash

description:
Stash keybindings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: pop stash

description:
A pop stash keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: rename stash

description:
A rename stash keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: commit files

description:
Commit file keybindings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: checkout commit file

description:
A checkout commit file keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: main

description:
Main keybindings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: toggle drag select

description:
A toggle drag select keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: toggle drag select-alt

description:
A toggle drag select-alt keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: toggle select hunk

description:
A toggle select hunk keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: pick both hunks

description:
A pick both hunks keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: submodules

description:
Submodules keybindings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: init

description:
An init keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: update

description:
An update keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: bulk menu

description:
A bulk menu keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default

title: services

description:
Service settings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls

title: service

description:
A service
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls

title: custom commands

description:
Custom commands
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings

description:
A custom command
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings

title: key

description:
A command trigger
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings

title: command

description:
A command
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings

examples: git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD

title: context

description:
A context
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings

enum: status files worktrees localBranches remotes remoteBranches tags commits reflogCommits subCommits commitFiles stash global

title: subprocess

description:
Whether to run command in subprocess
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings

title: prompts

description:
Prompts before running a command
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings

description:
A prompt before running a command
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings

title: initial value

description:
An initial value
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#input

title: suggestions

description:
Whether to show suggestions as the input is entered
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#input

title: preset

description:
A preset
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#input

enum: authors branches files refs remotes remoteBranches tags

title: command

description:
A command where each line in the output is suggestion
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#input

title: body

description:
A body
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#confirm

examples: Are you sure you want to push to the remote?

title: options

description:
Options
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu

description: An option

title: name

description:
A first label part
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu

title: description

description:
A second label part
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu

title: value

description:
the value that will be used in the command
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu

title: command

description:
A command to generate options
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu-from-command

examples: git branch  -r --list {{.SelectedRemote.Name }}/*

title: filter

description:
A regex specifying groups which kept from command output
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu-from-command

title: valueFormat

description:
A value format
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu-from-command

title: labelFormat

description:
A label format
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu-from-command

title: loading text

description:
Text to display while waiting for command to finish
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings

title: description

description:
A description
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings

title: stream

description:
Whether to stream command output to Command Log panel
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings

title: show output

description:
Whether to show the command output in popup
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings

title: after

description:
Actions to take after the command has completed
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings

title: check for conflicts

description:
Whether to check for conflicts before running command
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings

title: ui settings


goss-json-schema.json

$ref: #/definitions/meta

$ref: #/definitions/title

description: in milliseconds

description: can be a string or pattern, see https://github.com/goss-org/goss/blob/master/docs/manual.md#patterns

description: Validates the exit-status and output of a command

description: command to execute, defaults to the hash key

default: xfs

default: rw relatime

description: % of blocks used in this mountpoint

description: what IP(s) is it listening on

required: running skip

description: To see the full list of current values, run sysctl -a.

default: Linux

required: enabled running skip

description: list of addresses e.g. ["127.0.0.1", "::1"]

description: Eg 8.8.8.8. Also supports server:port

enum: file symlink directory

default: file

description: A stronger checksum alternatives to md5 (recommended)

description: md5 checksum of file

description: in bytes

default: root

description: string or patterns

description: Check file content for these patterns. can be a string or a pattern

$ref: #/definitions/matchingTest

description: meta (arbitrary data) attributes are persisted when adding other resources with goss add

description: Set request header values, e.g. [ "Content-Type: text/html" ]

description:
Check http response headers for these patterns (e.g. "Content-Type: text/html")
NOTE: only the first Host header will be used to set the Request.Host value if multiple are provided.

description: Check http response content for these patterns

description: certificate file to use for authentication (used with key-file)

description: request body

description: Setting this to true will NOT follow redirects

description: proxy server to proxy traffic through. Proxy can also be set with environment variables http_proxy.

enum: GET PUT HEAD POST DELETE PATCH CONNECT OPTIONS TRACE

description: http method

description: private-key file to use for authentication (used with cert-file)

description: CA root certs pem file, ex: /etc/ssl/cert.pem

description: username for basic auth

description: password for basic auth

description: title attribute is persisted when adding other resources with goss add

default: UID must be between 50-100, GID doesn't matter. home is flexible

title: Goss-file-schema

description: Validates mount point attributes.

description: Validates the state of a service.

description:
Validates the state of a user"
NOTE: This check is inspecting the contents of local passwd file /etc/passwd, this does not validate remote users (e.g. LDAP).

description: Validates if a remote address:port are accessible.

description: Validates the state of a file, directory, or symbolic link

description: Validates the state of a group

description:
Import other gossfiles from this one. This is the best way to maintain a large number of tests, and/or create profiles. See render for more examples. Glob patterns can be also be used to specify matching gossfiles.
You can specify the gossfile(s) either as the resource key, or using the 'file' attribute.

If the 'skip' attribute is true, then the file is not processed. If the filename is a glob pattern, then none of the matching files are processed. Note that this is not the same as skipping the contained resources; any overrides in the referenced gossfile will not be processed, and the resource count will not be incremented. Skipping a gossfile include is the same as omitting the gossfile resource entirely.

x-intellij-html-description:
Import other gossfiles from this one. This is the best way to maintain a large number of tests, and/or create profiles. See render for more examples. Glob patterns can be also be used to specify matching gossfiles.

gossfile:
  myapplication:
    file: myapp_gossfile.yaml
    skip: false
  *.yaml:
    skip: true
  goss_httpd.yaml: {}
  /etc/goss.d/*.yaml: {}

    <clipboard-copy aria-label="Copy" class="ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay" data-copy-feedback="Copied!" data-tooltip-direction="w" value="gossfile:
  myapplication:
    file: myapp_gossfile.yaml
    skip: false
  *.yaml:
    skip: true
  goss_httpd.yaml: {}
  /etc/goss.d/*.yaml: {}" tabindex="0" role="button" style="display: none;">
      <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-copy js-clipboard-copy-icon m-2">
    <path fill-rule="evenodd" d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z"></path><path fill-rule="evenodd" d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z"></path>
</svg>
      <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2">
    <path fill-rule="evenodd" d="M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z"></path>
</svg>
    </clipboard-copy>

You can specify the gossfile(s) either as the resource key, or using the 'file' attribute.

If the 'skip' attribute is true, then the file is not processed.  If the filename is a glob pattern, then none of the matching files are processed.  Note that this is not the same as skipping the contained resources; any overrides in the referenced gossfile will not be processed, and the resource count will not be incremented.  Skipping a gossfile include is the same as omitting the gossfile resource entirely.

description: Validates if a process is running.

description: description: Validates network interface values

description: test executing a command

description:
Validates the state of a package"
NOTE: this check uses the --package <format> parameter passed on the command line.

description: test

description: test

description: Validates specified content against a matcher. Best used with Templates.

x-intellij-html-description:
Validates that the provided address is resolvable and the addrs it resolves to.

dns:
  localhost:
    # required attributes
    resolvable: true
    # optional attributes
    addrs:
    - 127.0.0.1
    - ::1
    server: 8.8.8.8 # Also supports server:port
    timeout: 500 # in milliseconds (Only used when server attribute is provided)

    <clipboard-copy aria-label="Copy" class="ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay" data-copy-feedback="Copied!" data-tooltip-direction="w" value="dns:
  localhost:
    # required attributes
    resolvable: true
    # optional attributes
    addrs:
    - 127.0.0.1
    - ::1
    server: 8.8.8.8 # Also supports server:port
    timeout: 500 # in milliseconds (Only used when server attribute is provided)" tabindex="0" role="button" style="display: none;">
      <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-copy js-clipboard-copy-icon m-2">
    <path fill-rule="evenodd" d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z"></path><path fill-rule="evenodd" d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z"></path>
</svg>
      <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2">
    <path fill-rule="evenodd" d="M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z"></path>
</svg>
    </clipboard-copy>

It is possible to validate the following types of DNS records, but requires the server attribute be set:

A

AAAA

CAA

CNAME

MX

NS

PTR

SRV

TXT

To validate specific DNS address types, prepend the hostname with the type and a colon, a few examples:

dns:
  # Validate a CNAME record
  CNAME:c.dnstest.io:
    resolvable: true
    server: 208.67.222.222
    addrs:
    - "a.dnstest.io."

  # Validate a PTR record
  PTR:8.8.8.8:
    resolvable: true
    server: 8.8.8.8
    addrs:
    - "dns.google."

  # Validate and SRV record
  SRV:_https._tcp.dnstest.io:
    resolvable: true
    server: 208.67.222.222
    addrs:
    - "0 5 443 a.dnstest.io."
    - "10 10 443 b.dnstest.io."

    <clipboard-copy aria-label="Copy" class="ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay" data-copy-feedback="Copied!" data-tooltip-direction="w" value="dns:
  # Validate a CNAME record
  CNAME:c.dnstest.io:
    resolvable: true
    server: 208.67.222.222
    addrs:
    - "a.dnstest.io."

  # Validate a PTR record
  PTR:8.8.8.8:
    resolvable: true
    server: 8.8.8.8
    addrs:
    - "dns.google."

  # Validate and SRV record
  SRV:_https._tcp.dnstest.io:
    resolvable: true
    server: 208.67.222.222
    addrs:
    - "0 5 443 a.dnstest.io."
    - "10 10 443 b.dnstest.io."" tabindex="0" role="button">
      <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-copy js-clipboard-copy-icon m-2">
    <path fill-rule="evenodd" d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z"></path><path fill-rule="evenodd" d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z"></path>
</svg>
      <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2">
    <path fill-rule="evenodd" d="M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z"></path>
</svg>
    </clipboard-copy>

Please note that if you want localhost to only resolve 127.0.0.1 you'll need to use Advanced Matchers

dns:
  localhost:
    resolvable: true
    addrs:
      consist-of: [127.0.0.1]
    timeout: 500 # in milliseconds

x-intellij-html-description:
Validates the state of a local port.

Note: Goss might consider your port to be listening on tcp6 rather than tcp, try running goss add port .. to see how goss detects it. (explanation)

port:
  # {tcp,tcp6,udp,udp6}:port_num
  tcp:22:
    # required attributes
    listening: true
    # optional attributes
    ip: # what IP(s) is it listening on
    - 0.0.0.0
    skip: false

description: A file describing a series of tests


description: The URI of the JSON schema corresponding to the version of the external property file format.

format: uri

description: The SARIF format version of this external properties object.

description: A stable, unique identifer for this external properties object, in the form of a GUID.

description: A stable, unique identifer for the run associated with this external properties object, in the form of a GUID.

description: A conversion object that will be merged with an external run.

description: An array of graph objects that will be merged with an external run.

description: Key/value pairs that provide additional information that will be merged with an external run.

description: An array of artifact objects that will be merged with an external run.

description: Describes the invocation of the analysis tool that will be merged with an external run.

description: An array of logical locations such as namespaces, types or functions that will be merged with an external run.

description: An array of threadFlowLocation objects that will be merged with an external run.

description: An array of result objects that will be merged with an external run.

description: Tool taxonomies that will be merged with an external run.

description: The analysis tool object that will be merged with an external run.

description: Tool extensions that will be merged with an external run.

description: Tool policies that will be merged with an external run.

description: Tool translations that will be merged with an external run.

description: Addresses that will be merged with with an external run.

description: Requests that will be merged with an external run.

description: Responses that will be merged with an external run.

description: Key/value pairs that provide additional information about the external properties.

title: SARIF External Property File Schema Version 2.1.0 JSON Schema


putout.json

description:
🐊Putout rule

"off" means rule is off
"on" means it is a on

enum: on off

description: 🐊Putout comes with a large number of rules. You can modify which rules your project uses.

$ref: #/definitions/rule

description: Tell 🐊Putout which printer to use

description: Tell 🐊Putout which parser to use

description: Choose the way to show information about errors found

description: Tell 🐊Putout which processors to use to support file types other then JavaScript

description: Tell 🐊Putout to ignore specific files and directories.

description: Allows to match rules for files and folders, specified by glob patterns.

description: Tell 🐊Putout which plugins to load


description: A file relevant to a tool invocation or to a result.

description: A message describing the role played by the attachment.

$ref: #/definitions/message

description: The location of the attachment.

$ref: #/definitions/fileLocation

description: An array of regions of interest within the attachment.

$ref: #/definitions/region

description: An array of rectangles specifying areas of interest within the image.

$ref: #/definitions/rectangle

description: A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.

description: A message relevant to the code flow.

description: An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.

$ref: #/definitions/threadFlow

description: Key/value pairs that provide additional information about the code flow.

description: A set of distinct strings that provide additional information.

description: Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.

description: A tool object that describes the converter.

$ref: #/definitions/tool

description: An invocation object that describes the invocation of the converter.

$ref: #/definitions/invocation

description: The locations of the analysis tool's per-run log files.

description: Represents a directed edge in a graph.

description: A string that uniquely identifies the edge within its graph.

description: A short description of the edge.

description: Identifies the source node (the node at which the edge starts).

description: Identifies the target node (the node at which the edge ends).

description: Key/value pairs that provide additional information about the edge.

required: id sourceNodeId targetNodeId

description: Represents the traversal of a single edge during a graph traversal.

description: Identifies the edge being traversed.

description: A message to display to the user as the edge is traversed.

description: The values of relevant expressions after the edge has been traversed.

description: The number of edge traversals necessary to return from a nested graph.

description: Key/value pairs that provide additional information about the edge traversal.

description: A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.

description: A plain text message that describes the exception.

description: The sequence of function calls leading to the exception.

$ref: #/definitions/stack

description: An array of exception objects each of which is considered a cause of this exception.

$ref: #/definitions/exception

description: References to external files that should be inlined with the content of a root log file.

description: The location of a file containing a run.conversion object to be merged with the root log file.

description: The location of a file containing a run.files object to be merged with the root log file.

description: The location of a file containing a run.graphs object to be merged with the root log file.

description: An array of locations of files containing arrays of run.invocation objects to be merged with the root log file.

description: The location of a file containing a run.logicalLocations object to be merged with the root log file.

description: The location of a file containing a run.resources object to be merged with the root log file.

description: An array of locations of files containing arrays of run.result objects to be merged with the root log file.

description: A single file. In some cases, this file might be nested within another file.

description: The location of the file.

description: Identifies the key of the immediate parent of the file, if this file is nested.

description: The offset in bytes of the file within its containing file.

description: The length of the file in bytes.

description: The role or roles played by the file in the analysis.

enum: analysisTarget attachment responseFile resultFile standardStream traceFile unmodifiedFile modifiedFile addedFile deletedFile renamedFile uncontrolledFile

description: The MIME type (RFC 2045) of the file.

description: The contents of the file.

$ref: #/definitions/fileContent

description: Specifies the encoding for a file object that refers to a text file.

description: An array of hash objects, each of which specifies a hashed value for the file, along with the name of the hash function used to compute the hash.

$ref: #/definitions/hash

description: The date and time at which the file was most recently modified. See "Date/time properties" in the SARIF spec for the required format.

format: date-time

description: Key/value pairs that provide additional information about the file.

description: A change to a single file.

description: The location of the file to change.

description: An array of replacement objects, each of which represents the replacement of a single region in a single file specified by 'fileLocation'.

$ref: #/definitions/replacement

required: fileLocation replacements

description: Represents content from an external file.

description: UTF-8-encoded content from a text file.

description: MIME Base64-encoded content from a binary file, or from a text file in its original encoding.

description: Specifies the location of a file.

description: A string containing a valid relative or absolute URI.

format: uri-reference

description: A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

description: A proposed fix for the problem represented by a result object. A fix specifies a set of file to modify. For each file, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.

description: A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.

description: One or more file changes that comprise a fix for a result.

$ref: #/definitions/fileChange

description: A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).

description: A string that uniquely identifies the graph within a run.graphs or result.graphs array.

description: A description of the graph.

description: An array of node objects representing the nodes of the graph.

$ref: #/definitions/node

description: An array of edge objects representing the edges of the graph.

$ref: #/definitions/edge

description: Key/value pairs that provide additional information about the graph.

required: id nodes edges

description: Represents a path through a graph.

description: A string that uniquely identifies that graph being traversed.

description: A description of this graph traversal.

description: Values of relevant expressions at the start of the graph traversal.

description: The sequences of edges traversed by this graph traversal.

description: Key/value pairs that provide additional information about the graph traversal.

description: A hash value of some file or collection of files, together with the hash function used to compute the hash.

description: The hash value of some file or collection of files, computed by the hash function named in the 'algorithm' property.

description: The name of the hash function used to compute the hash value specified in the 'value' property.

description: The runtime environment of the analysis tool run.

description: The command line used to invoke the tool.

description: An array of strings, containing in order the command line arguments passed to the tool from the operating system.

description: The locations of any response files specified on the tool's command line.

description: A set of files relevant to the invocation of the tool.

description: The date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

description: The date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.

description: The process exit code.

description: A list of runtime conditions detected by the tool during the analysis.

description: A list of conditions detected by the tool that are relevant to the tool's configuration.

description: The reason for the process exit.

description: The name of the signal that caused the process to exit.

description: The numeric value of the signal that caused the process to exit.

description: The reason given by the operating system that the process failed to start.

description: A value indicating whether the tool's execution completed successfully.

description: The machine that hosted the analysis tool run.

description: The account that ran the analysis tool.

description: The process id for the analysis tool run.

description: An absolute URI specifying the location of the analysis tool's executable.

description: The working directory for the analysis tool run.

description: The environment variables associated with the analysis tool process, expressed as key/value pairs.

description: A file containing the standard input stream to the process that was invoked.

description: A file containing the standard output stream from the process that was invoked.

description: A file containing the standard error stream from the process that was invoked.

description: A file containing the interleaved standard output and standard error stream from the process that was invoked.

description: Key/value pairs that provide additional information about the invocation.

description: A location within a programming artifact.

description: Identifies the file and region.

description: The human-readable fully qualified name of the logical location. If run.logicalLocations is present, this value matches a property name within that object, from which further information about the logical location can be obtained.

description: A message relevant to the location.

description: A set of regions relevant to the location.

description: Key/value pairs that provide additional information about the location.

description: A logical location of a construct that produced a result.

description: Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.

description: The human-readable fully qualified name of the logical location.

description: The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.

description: Identifies the key of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.

description: The type of construct this logicalLocationComponent refers to. Should be one of 'function', 'member', 'module', 'namespace', 'package', 'parameter', 'resource', 'returnType', 'type', or 'variable', if any of those accurately describe the construct.

description: Encapsulates a message intended to be read by the end user.

description: A plain text message string.

description: The resource id for a plain text message string.

description: A rich text message string.

description: The resource id for a rich text message string.

description: An array of strings to substitute into the message string.

description: Represents a node in a graph.

description: A string that uniquely identifies the node within its graph.

description: A short description of the node.

description: A code location associated with the node.

description: Array of child nodes.

description: Key/value pairs that provide additional information about the node.

description: Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.

description: An identifier for the condition that was encountered.

description: The stable, unique identifier of the rule (if any) to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.

description: The file and region relevant to this notification.

description: A message that describes the condition that was encountered.

description: A value specifying the severity level of the notification.

description: The thread identifier of the code that generated the notification.

description: The date and time at which the analysis tool generated the notification.

description: The runtime exception, if any, relevant to this notification.

description: Key/value pairs that provide additional information about the notification.

description: A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.

description: Value that distinguishes this physical location from all other physical locations in this run object.

description: The location of the file.

description: Specifies a portion of the file.

description: Specifies a portion of the file that encloses the region. Allows a viewer to display additional context around the region.

description: An area within an image.

description: The Y coordinate of the top edge of the rectangle, measured in the image's natural units.

description: The X coordinate of the left edge of the rectangle, measured in the image's natural units.

description: The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.

description: The X coordinate of the right edge of the rectangle, measured in the image's natural units.

description: A message relevant to the rectangle.

description: A region within a file where a result was detected.

description: The line number of the first character in the region.

description: The column number of the first character in the region.

description: The line number of the last character in the region.

description: The column number of the character following the end of the region.

description: The zero-based offset from the beginning of the file of the first character in the region.

description: The length of the region in characters.

description: The zero-based offset from the beginning of the file of the first byte in the region.

description: The length of the region in bytes.

description: The portion of the file contents within the specified region.

description: A message relevant to the region.

description: The replacement of a single region of a file.

description: The region of the file to delete.

description: The content to insert at the location specified by the 'deletedRegion' property.

description: Container for items that require localization.

description: A dictionary, each of whose keys is a resource identifier and each of whose values is a localized string.

description: A dictionary, each of whose keys is a string and each of whose values is a 'rule' object, that describe all rules associated with an analysis tool or a specific run of an analysis tool.

description: A result produced by an analysis tool.

description: A value specifying the severity level of the result.

enum: notApplicable pass note warning error open

description: A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.

description: Identifies the file that the analysis tool was instructed to scan. This need not be the same as the file where the result actually occurred.

description: One or more locations where the result occurred. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.

description: A stable, unique identifier for the result in the form of a GUID.

description: A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.

description: A set of strings that contribute to the stable, unique identity of the result.

description: A set of strings each of which individually defines a stable, unique identity for the result.

description: An array of 'stack' objects relevant to the result.

description: An array of 'codeFlow' objects relevant to the result.

description: An array of one or more unique 'graph' objects.

description: An array of one or more unique 'graphTraversal' objects.

description: A set of locations relevant to this result.

description: A set of flags indicating one or more suppression conditions.

description: The state of a result relative to a baseline of a previous run.

description: A set of files relevant to the result.

description: The URIs of the work items associated with this result

description: An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result object.

description: An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.

description: Key/value pairs that provide additional information about the result.

description: Describes an analysis rule.

description: A stable, opaque identifier for the rule.

description: A rule identifier that is understandable to an end user.

description: A concise description of the rule. Should be a single sentence that is understandable when visible space is limited to a single line of text.

description: A description of the rule. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.

description: A set of name/value pairs with arbitrary names. The value within each name/value pair consists of plain text interspersed with placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

description: A set of name/value pairs with arbitrary names. The value within each name/value pair consists of rich text interspersed with placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

description: Information about the rule that can be configured at runtime.

description: A URI where the primary documentation for the rule can be found.

description: Provides the primary documentation for the rule, useful when there is no online documentation.

description: Key/value pairs that provide additional information about the rule.

description: Information about a rule that can be configured at runtime.

description: Specifies whether the rule will be evaluated during the scan.

description: Specifies the default severity level of the result.

description: Contains configuration information specific to this rule.

description: A set of distinct strings that provide additional configuration information.

description: Describes a single run of an analysis tool, and contains the output of that run.

description: Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.

description: Describes the invocation of the analysis tool.

description: A conversion object that describes how a converter transformed an analysis tool's native output format into the SARIF format.

description: Specifies the revision in version control of the files that were scanned.

description: The absolute URI specified by each uriBaseId symbol on the machine where the tool originally ran.

description: A dictionary, each of whose keys is a URI and each of whose values is a file object.

description: A dictionary, each of whose keys specifies a logical location such as a namespace, type or function.

description: The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.

description: Items that can be localized, such as message strings and rule metadata.

description: A stable, unique identifier for the run, in the form of a GUID.

description: A stable, unique identifier for the class of related runs to which this run belongs, in the form of a GUID.

description: A logical identifier for a run, for example, 'nightly Clang analyzer run'. Multiple runs of the same type can have the same logical id.

description: A description of the run.

description: A global identifier that allows the run to be correlated with other artifacts produced by a larger automation process.

description: The 'instanceGuid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.

description: The hardware architecture for which the run was targeted.

description: The MIME type of all rich text message properties in the run. Default: "text/markdown;variant=GFM"

description: The string used to replace sensitive information in a redaction-aware property.

description: Specifies the default encoding for any file object that refers to a text file.

description: Specifies the unit in which the tool measures columns.

description: Key/value pairs that provide additional information about the run.

description: A set of distinct strings that provide additional information about the run.

description: A call stack that is relevant to a result.

description: A message relevant to this call stack.

description: An array of stack frames that represent a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

description: Key/value pairs that provide additional information about the stack.

description: A function call within a stack trace.

description: The location to which this stack frame refers.

description: The name of the module that contains the code of this stack frame.

description: The thread identifier of the stack frame.

description: The address of the method or function that is executing.

description: The offset from the method or function that is executing.

description: The parameters of the call that is executing.

description: Key/value pairs that provide additional information about the stack frame.

description: An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.

description: A message relevant to the thread flow.

description: A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.

description: Key/value pairs that provide additional information about the thread flow.

description: A location visited by an analysis tool while simulating or monitoring the execution of a program.

description: The 0-based sequence number of the location in the code flow within which it occurs.

description: The code location.

description: The call stack leading to this location.

description: A string describing the type of this location.

description: The name of the module that contains the code that is executing.

description: A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.

description: An integer representing a containment hierarchy within the thread flow

description: An integer representing the temporal order in which execution reached this location.

description: The time at which this location was executed.

description: Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".

description: Key/value pairs that provide additional information about the code location.

description: The analysis tool that was run.

description: The name of the tool.

description: The name of the tool along with its version and any other useful identifying information, such as its locale.

description: The tool version, in whatever format the tool natively provides.

description: The tool version in the format specified by Semantic Versioning 2.0.

description: The binary version of the tool's primary executable file (for operating systems such as Windows that provide that information).

description: The absolute URI from which the tool can be downloaded.

description: A version that uniquely identifies the SARIF logging component that generated this file, if it is versioned separately from the tool.

description: The tool language (expressed as an ISO 649 two-letter lowercase culture code) and region (expressed as an ISO 3166 two-letter uppercase subculture code associated with a country or region).

description: Key/value pairs that provide additional information about the tool.

description: Specifies the information necessary to retrieve a desired revision from a version control system.

description: The absolute URI of the repository.

description: A string that uniquely and permanently identifies the revision within the repository.

description: The name of a branch containing the revision.

description: A tag that has been applied to the revision.

description: The date and time at which the revision was created.

description: Key/value pairs that provide additional information about the revision.

description: Static Analysis Results Format (SARIF) Version 2.0.0 JSON Schema: a standard format for the output of static analysis tools.

description: The URI of the JSON schema corresponding to the version.

description: The SARIF format version of this log file.

description: The set of runs contained in this log file.

title: Static Analysis Results Format (SARIF) Version 2.0.0 JSON Schema


description: The URI of the JSON schema corresponding to the version of the external property file format.

description: The SARIF format version of this external properties object.

description: A stable, unique identifier for this external properties object, in the form of a GUID.

description: A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.

description: A conversion object that will be merged with an external run.

description: An array of graph objects that will merged with an external run.

description: Key/value pairs that provide additional information that will be merged with an external run.

description: An array of artifact objects that will be merged with an external run.

description: Describes the invocation of the analysis tool that will be merged with an external run.

description: An array of logical locations such as namespaces, types or functions that will be merged with an external run.

description: An array of threadFlowLocation objects that will be merged with an external run.

description: An array of result objects that will be merged with an external run.

description: Tool taxonomies that will be merged with an external run.

description: The analysis tool object that will be merged with an external run.

description: Tool extensions that will be merged with an external run.

description: Tool policies that will be merged with an external run.

description: Tool translations that will be merged with an external run.

description: Addresses that will be merged with with an external run.

description: Requests that will be merged with an external run.

description: Responses that will be merged with an external run.

description: Key/value pairs that provide additional information about the external properties.

title: SARIF External Property File Schema Version 2.1.0-rtm.4 JSON Schema