schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
lazygit.json
|
viewGitFlowOptions
|
A view git flow options keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "i"}
|
lazygit.json
|
fastForward
|
A fast forward keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "f"}
|
lazygit.json
|
createTag
|
A create tag keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "T"}
|
lazygit.json
|
pushTag
|
A push tag keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "P"}
|
lazygit.json
|
setUpstream
|
A set upstream keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "u"}
|
lazygit.json
|
fetchRemote
|
A fetch remote keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "f"}
|
lazygit.json
|
commits
|
Commit keybindings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"type": "object", "properties": {"squashDown": {"default": "s"}, "renameCommit": {"default": "r"}, "renameCommitWithEditor": {"default": "R"}, "viewResetOptions": {"default": "g"}, "markCommitAsFixup": {"default": "f"}, "createFixupCommit": {"default": "F"}, "squashAboveCommits": {"default": "S"}, "moveDownCommit": {"default": "<c-j>"}, "moveUpCommit": {"default": "<c-k>"}, "amendToCommit": {"default": "A"}, "pickCommit": {"default": "p"}, "revertCommit": {"default": "t"}, "cherryPickCopy": {"default": "c"}, "cherryPickCopyRange": {"default": "C"}, "pasteCommits": {"default": "v"}, "tagCommit": {"default": "T"}, "checkoutCommit": {"default": "<space>"}, "resetCherryPick": {"default": "<c-R>"}, "copyCommitMessageToClipboard": {"default": "<c-y>"}, "openLogMenu": {"default": "<c-l>"}, "viewBisectOptions": {"default": "b"}}, "additionalProperties": false}
|
lazygit.json
|
squashDown
|
A squash down keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "s"}
|
lazygit.json
|
renameCommit
|
A rename commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "r"}
|
lazygit.json
|
renameCommitWithEditor
|
A rename commit with editor keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "R"}
|
lazygit.json
|
viewResetOptions
|
A view reset options keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "g"}
|
lazygit.json
|
markCommitAsFixup
|
A mark commit as fixup keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "f"}
|
lazygit.json
|
createFixupCommit
|
A create fixup commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "F"}
|
lazygit.json
|
squashAboveCommits
|
A squash above commits keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "S"}
|
lazygit.json
|
moveDownCommit
|
A move down commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "<c-j>"}
|
lazygit.json
|
moveUpCommit
|
A move up commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "<c-k>"}
|
lazygit.json
|
amendToCommit
|
A amend to commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "A"}
|
lazygit.json
|
pickCommit
|
A pick commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "p"}
|
lazygit.json
|
revertCommit
|
A revert commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "t"}
|
lazygit.json
|
cherryPickCopy
|
A cherry pick copy keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "c"}
|
lazygit.json
|
cherryPickCopyRange
|
A cherry pick copy range keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "C"}
|
lazygit.json
|
pasteCommits
|
A paste commits keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "v"}
|
lazygit.json
|
tagCommit
|
A tag commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "T"}
|
lazygit.json
|
checkoutCommit
|
A checkout commit keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "<space>"}
|
lazygit.json
|
resetCherryPick
|
A reset cherry pick keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "<c-R>"}
|
lazygit.json
|
copyCommitMessageToClipboard
|
A copy commit message to clipboard keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "<c-y>"}
|
lazygit.json
|
openLogMenu
|
A open log menu keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "<c-l>"}
|
lazygit.json
|
viewBisectOptions
|
A view bisect options keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "b"}
|
lazygit.json
|
stash
|
Stash keybindings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"type": "object", "properties": {"popStash": {"default": "g"}, "renameStash": {"default": "r"}}, "additionalProperties": false}
|
lazygit.json
|
popStash
|
A pop stash keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "g"}
|
lazygit.json
|
renameStash
|
A rename stash keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "r"}
|
lazygit.json
|
commitFiles
|
Commit file keybindings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"type": "object", "properties": {"checkoutCommitFile": {"default": "c"}}, "additionalProperties": false}
|
lazygit.json
|
checkoutCommitFile
|
A checkout commit file keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "c"}
|
lazygit.json
|
main
|
Main keybindings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"type": "object", "properties": {"toggleDragSelect": {"default": "v"}, "toggleDragSelect-alt": {"default": "V"}, "toggleSelectHunk": {"default": "a"}, "pickBothHunks": {"default": "b"}}, "additionalProperties": false}
|
lazygit.json
|
toggleDragSelect
|
A toggle drag select keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "v"}
|
lazygit.json
|
toggleDragSelect-alt
|
A toggle drag select-alt keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "V"}
|
lazygit.json
|
toggleSelectHunk
|
A toggle select hunk keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "a"}
|
lazygit.json
|
pickBothHunks
|
A pick both hunks keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "b"}
|
lazygit.json
|
submodules
|
Submodules keybindings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"type": "object", "properties": {"init": {"default": "i"}, "update": {"default": "u"}, "bulkMenu": {"default": "b"}}, "additionalProperties": false}
|
lazygit.json
|
init
|
An init keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "i"}
|
lazygit.json
|
update
|
An update keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "u"}
|
lazygit.json
|
bulkMenu
|
A bulk menu keybinding
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default
|
{"default": "b"}
|
lazygit.json
|
services
|
Service settings
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls
|
{"type": "object", "patternProperties": {".": {"type": "string", "pattern": "^[^:]+:[^:]+$"}}, "additionalProperties": false}
|
lazygit.json
|
.
|
A service
https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls
|
{"type": "string", "pattern": "^[^:]+:[^:]+$"}
|
lazygit.json
|
customCommands
|
Custom commands
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings
|
{"type": "array", "uniqueItems": true, "items": {"type": "object", "required": ["key", "command", "context"], "properties": {"key": {}, "command": {"type": "string", "default": "", "examples": ["git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"]}, "context": {"type": "string", "enum": ["status", "files", "worktrees", "localBranches", "remotes", "remoteBranches", "tags", "commits", "reflogCommits", "subCommits", "commitFiles", "stash", "global"]}, "subprocess": {"type": "boolean", "default": false}, "prompts": {"type": "array", "items": {"type": "object", "required": ["type", "title", "key"], "properties": {"type": {}, "key": {}}, "allOf": [{"if": {"properties": {"type": {"const": "input"}}}, "then": {"properties": {"type": {}, "key": {}, "initialValue": {"type": "string"}, "suggestions": {"type": "object", "oneOf": [{"properties": {"preset": {"type": "string", "enum": ["authors", "branches", "files", "refs", "remotes", "remoteBranches", "tags"]}}, "additionalProperties": false}, {"properties": {"command": {"type": "string", "default": "", "examples": ["git branch --format='%(refname:short)'"]}}, "additionalProperties": false}]}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "confirm"}}}, "then": {"properties": {"type": {}, "key": {}, "body": {"type": "string", "examples": ["Are you sure you want to push to the remote?"]}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "menu"}}}, "then": {"required": ["options"], "properties": {"type": {}, "key": {}, "options": {"type": "array", "uniqueItems": true, "items": {"type": "object", "required": ["value"], "properties": {"name": {"type": "string", "default": ""}, "value": {"type": "string", "minLength": 1, "examples": ["feature"]}}, "additionalProperties": false}}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "menuFromCommand"}}}, "then": {"required": ["command"], "properties": {"type": {}, "key": {}, "command": {"type": "string", "default": "", "examples": ["git branch -r --list {{.SelectedRemote.Name }}/*"]}, "filter": {"type": "string", "default": "", "examples": [".*{{.SelectedRemote.Name }}/(?P<branch>.*)"]}, "valueFormat": {"type": "string", "default": "", "examples": ["{{ .branch }}"]}, "labelFormat": {"type": "string", "default": "", "examples": ["{{ .branch | green }}"]}}, "additionalProperties": false}}]}}, "loadingText": {"type": "string", "default": "", "examples": ["Loading..."]}, "stream": {"type": "boolean", "default": false}, "showOutput": {"type": "boolean", "default": false}, "after": {"type": "object", "properties": {"checkForConflicts": {"type": "boolean", "default": false}}, "additionalProperties": false}}, "additionalProperties": false}}
|
lazygit.json
|
items
|
A custom command
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings
|
{"type": "object", "required": ["key", "command", "context"], "properties": {"key": {}, "command": {"type": "string", "default": "", "examples": ["git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"]}, "context": {"type": "string", "enum": ["status", "files", "worktrees", "localBranches", "remotes", "remoteBranches", "tags", "commits", "reflogCommits", "subCommits", "commitFiles", "stash", "global"]}, "subprocess": {"type": "boolean", "default": false}, "prompts": {"type": "array", "items": {"type": "object", "required": ["type", "title", "key"], "properties": {"type": {}, "key": {}}, "allOf": [{"if": {"properties": {"type": {"const": "input"}}}, "then": {"properties": {"type": {}, "key": {}, "initialValue": {"type": "string"}, "suggestions": {"type": "object", "oneOf": [{"properties": {"preset": {"type": "string", "enum": ["authors", "branches", "files", "refs", "remotes", "remoteBranches", "tags"]}}, "additionalProperties": false}, {"properties": {"command": {"type": "string", "default": "", "examples": ["git branch --format='%(refname:short)'"]}}, "additionalProperties": false}]}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "confirm"}}}, "then": {"properties": {"type": {}, "key": {}, "body": {"type": "string", "examples": ["Are you sure you want to push to the remote?"]}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "menu"}}}, "then": {"required": ["options"], "properties": {"type": {}, "key": {}, "options": {"type": "array", "uniqueItems": true, "items": {"type": "object", "required": ["value"], "properties": {"name": {"type": "string", "default": ""}, "value": {"type": "string", "minLength": 1, "examples": ["feature"]}}, "additionalProperties": false}}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "menuFromCommand"}}}, "then": {"required": ["command"], "properties": {"type": {}, "key": {}, "command": {"type": "string", "default": "", "examples": ["git branch -r --list {{.SelectedRemote.Name }}/*"]}, "filter": {"type": "string", "default": "", "examples": [".*{{.SelectedRemote.Name }}/(?P<branch>.*)"]}, "valueFormat": {"type": "string", "default": "", "examples": ["{{ .branch }}"]}, "labelFormat": {"type": "string", "default": "", "examples": ["{{ .branch | green }}"]}}, "additionalProperties": false}}]}}, "loadingText": {"type": "string", "default": "", "examples": ["Loading..."]}, "stream": {"type": "boolean", "default": false}, "showOutput": {"type": "boolean", "default": false}, "after": {"type": "object", "properties": {"checkForConflicts": {"type": "boolean", "default": false}}, "additionalProperties": false}}, "additionalProperties": false}
|
lazygit.json
|
key
|
A command trigger
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings
|
{}
|
lazygit.json
|
command
|
A command
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings
|
{"type": "string", "default": "", "examples": ["git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"]}
|
lazygit.json
|
context
|
A context
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings
|
{"type": "string", "enum": ["status", "files", "worktrees", "localBranches", "remotes", "remoteBranches", "tags", "commits", "reflogCommits", "subCommits", "commitFiles", "stash", "global"]}
|
lazygit.json
|
subprocess
|
Whether to run command in subprocess
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings
|
{"type": "boolean", "default": false}
|
lazygit.json
|
prompts
|
Prompts before running a command
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings
|
{"type": "array", "items": {"type": "object", "required": ["type", "title", "key"], "properties": {"type": {}, "key": {}}, "allOf": [{"if": {"properties": {"type": {"const": "input"}}}, "then": {"properties": {"type": {}, "key": {}, "initialValue": {"type": "string"}, "suggestions": {"type": "object", "oneOf": [{"properties": {"preset": {"type": "string", "enum": ["authors", "branches", "files", "refs", "remotes", "remoteBranches", "tags"]}}, "additionalProperties": false}, {"properties": {"command": {"type": "string", "default": "", "examples": ["git branch --format='%(refname:short)'"]}}, "additionalProperties": false}]}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "confirm"}}}, "then": {"properties": {"type": {}, "key": {}, "body": {"type": "string", "examples": ["Are you sure you want to push to the remote?"]}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "menu"}}}, "then": {"required": ["options"], "properties": {"type": {}, "key": {}, "options": {"type": "array", "uniqueItems": true, "items": {"type": "object", "required": ["value"], "properties": {"name": {"type": "string", "default": ""}, "value": {"type": "string", "minLength": 1, "examples": ["feature"]}}, "additionalProperties": false}}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "menuFromCommand"}}}, "then": {"required": ["command"], "properties": {"type": {}, "key": {}, "command": {"type": "string", "default": "", "examples": ["git branch -r --list {{.SelectedRemote.Name }}/*"]}, "filter": {"type": "string", "default": "", "examples": [".*{{.SelectedRemote.Name }}/(?P<branch>.*)"]}, "valueFormat": {"type": "string", "default": "", "examples": ["{{ .branch }}"]}, "labelFormat": {"type": "string", "default": "", "examples": ["{{ .branch | green }}"]}}, "additionalProperties": false}}]}}
|
lazygit.json
|
items
|
A prompt before running a command
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings
|
{"type": "object", "required": ["type", "title", "key"], "properties": {"type": {}, "key": {}}, "allOf": [{"if": {"properties": {"type": {"const": "input"}}}, "then": {"properties": {"type": {}, "key": {}, "initialValue": {"type": "string"}, "suggestions": {"type": "object", "oneOf": [{"properties": {"preset": {"type": "string", "enum": ["authors", "branches", "files", "refs", "remotes", "remoteBranches", "tags"]}}, "additionalProperties": false}, {"properties": {"command": {"type": "string", "default": "", "examples": ["git branch --format='%(refname:short)'"]}}, "additionalProperties": false}]}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "confirm"}}}, "then": {"properties": {"type": {}, "key": {}, "body": {"type": "string", "examples": ["Are you sure you want to push to the remote?"]}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "menu"}}}, "then": {"required": ["options"], "properties": {"type": {}, "key": {}, "options": {"type": "array", "uniqueItems": true, "items": {"type": "object", "required": ["value"], "properties": {"name": {"type": "string", "default": ""}, "value": {"type": "string", "minLength": 1, "examples": ["feature"]}}, "additionalProperties": false}}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "menuFromCommand"}}}, "then": {"required": ["command"], "properties": {"type": {}, "key": {}, "command": {"type": "string", "default": "", "examples": ["git branch -r --list {{.SelectedRemote.Name }}/*"]}, "filter": {"type": "string", "default": "", "examples": [".*{{.SelectedRemote.Name }}/(?P<branch>.*)"]}, "valueFormat": {"type": "string", "default": "", "examples": ["{{ .branch }}"]}, "labelFormat": {"type": "string", "default": "", "examples": ["{{ .branch | green }}"]}}, "additionalProperties": false}}]}
|
lazygit.json
|
initialValue
|
An initial value
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#input
|
{"type": "string"}
|
lazygit.json
|
suggestions
|
Whether to show suggestions as the input is entered
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#input
|
{"type": "object", "oneOf": [{"properties": {"preset": {"type": "string", "enum": ["authors", "branches", "files", "refs", "remotes", "remoteBranches", "tags"]}}, "additionalProperties": false}, {"properties": {"command": {"type": "string", "default": "", "examples": ["git branch --format='%(refname:short)'"]}}, "additionalProperties": false}]}
|
lazygit.json
|
preset
|
A preset
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#input
|
{"type": "string", "enum": ["authors", "branches", "files", "refs", "remotes", "remoteBranches", "tags"]}
|
lazygit.json
|
command
|
A command where each line in the output is suggestion
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#input
|
{"type": "string", "default": "", "examples": ["git branch --format='%(refname:short)'"]}
|
lazygit.json
|
body
|
A body
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#confirm
|
{"type": "string", "examples": ["Are you sure you want to push to the remote?"]}
|
lazygit.json
|
options
|
Options
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu
|
{"type": "array", "uniqueItems": true, "items": {"type": "object", "required": ["value"], "properties": {"name": {"type": "string", "default": ""}, "value": {"type": "string", "minLength": 1, "examples": ["feature"]}}, "additionalProperties": false}}
|
lazygit.json
|
items
|
An option
|
{"type": "object", "required": ["value"], "properties": {"name": {"type": "string", "default": ""}, "value": {"type": "string", "minLength": 1, "examples": ["feature"]}}, "additionalProperties": false}
|
lazygit.json
|
name
|
A first label part
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu
|
{"type": "string", "default": ""}
|
lazygit.json
|
description
|
A second label part
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu
|
{"type": "string", "default": ""}
|
lazygit.json
|
value
|
the value that will be used in the command
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu
|
{"type": "string", "minLength": 1, "examples": ["feature"]}
|
lazygit.json
|
command
|
A command to generate options
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu-from-command
|
{"type": "string", "default": "", "examples": ["git branch -r --list {{.SelectedRemote.Name }}/*"]}
|
lazygit.json
|
filter
|
A regex specifying groups which kept from command output
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu-from-command
|
{"type": "string", "default": "", "examples": [".*{{.SelectedRemote.Name }}/(?P<branch>.*)"]}
|
lazygit.json
|
valueFormat
|
A value format
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu-from-command
|
{"type": "string", "default": "", "examples": ["{{ .branch }}"]}
|
lazygit.json
|
labelFormat
|
A label format
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu-from-command
|
{"type": "string", "default": "", "examples": ["{{ .branch | green }}"]}
|
lazygit.json
|
loadingText
|
Text to display while waiting for command to finish
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings
|
{"type": "string", "default": "", "examples": ["Loading..."]}
|
lazygit.json
|
description
|
A description
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings
|
{"type": "string", "default": "", "examples": ["Checkout a remote branch as FETCH_HEAD"]}
|
lazygit.json
|
stream
|
Whether to stream command output to Command Log panel
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings
|
{"type": "boolean", "default": false}
|
lazygit.json
|
showOutput
|
Whether to show the command output in popup
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings
|
{"type": "boolean", "default": false}
|
lazygit.json
|
after
|
Actions to take after the command has completed
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings
|
{"type": "object", "properties": {"checkForConflicts": {"type": "boolean", "default": false}}, "additionalProperties": false}
|
lazygit.json
|
checkForConflicts
|
Whether to check for conflicts before running command
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings
|
{"type": "boolean", "default": false}
|
goss-json-schema.json
|
A file describing a series of tests
|
{"type": "object", "definitions": {"gossfileTest": {"properties": {"meta": {}, "skip": {"default": "", "type": "boolean"}, "file": {"default": "myapp_gossfile.yaml", "type": "string"}}}, "packageTest": {"required": ["installed"], "properties": {"versions": {"oneOf": [{"type": "object"}, {"type": "array", "default": ["2.2.15"], "items": {"type": "string"}}]}, "installed": {"default": "1", "type": "boolean"}, "skip": {"type": "boolean", "default": ""}, "meta": {}}}, "commandTest": {"type": "object", "required": ["exit-status"], "properties": {"meta": {}, "timeout": {"type": "integer"}, "stdout": {"type": "array", "items": {"type": "string"}}, "stderr": {"type": "array", "items": {"type": "string"}}, "skip": {"default": "", "type": "boolean"}, "exit-status": {"type": "integer"}, "exec": {"type": "string"}}}, "mountTest": {"properties": {"meta": {}, "filesystem": {"default": "xfs", "type": "string"}, "opts": {"default": ["rw", "relatime"], "items": {"type": "string"}, "type": "array"}, "exists": {"default": "1", "type": "boolean"}, "source": {"type": "string", "default": "/dev/mapper/fedora-home"}, "usage": {"type": "object", "properties": {"lt": {"default": "95", "type": "integer"}}}}, "required": ["exists"]}, "portTest": {"required": ["listening"], "properties": {"listening": {"default": "1", "type": "boolean"}, "skip": {"type": "boolean", "default": ""}, "meta": {}, "ip": {"type": "array", "default": ["0.0.0.0"], "items": {"type": "string"}}}}, "interfaceTest": {"properties": {"addrs": {"items": {"type": "string"}, "default": ["172.17.0.2/16", "fe80::42:acff:fe11:2/64"], "type": "array"}, "meta": {}, "mtu": {"type": "integer", "default": "1500"}, "exists": {"default": "1", "type": "boolean"}}, "required": ["exists"]}, "processTest": {"required": ["running", "skip"], "properties": {"skip": {"default": "", "type": "boolean"}, "meta": {}, "running": {"default": "1", "type": "boolean"}}}, "kernelParamTest": {"properties": {"meta": {}, "value": {"default": "Linux", "type": "string"}}, "required": ["value"]}, "groupTest": {"required": ["exists"], "properties": {"gid": {"type": "integer", "default": "65534"}, "skip": {"type": "boolean", "default": ""}, "groups": {"type": "object"}, "exists": {"default": "1", "type": "boolean"}, "uid": {"type": "integer", "default": "65534"}, "meta": {}}}, "serviceTest": {"required": ["enabled", "running", "skip"], "properties": {"running": {"type": "boolean", "default": "1"}, "enabled": {"type": "boolean", "default": "1"}, "skip": {"default": "", "type": "boolean"}, "meta": {}}}, "dnsTest": {"required": ["resolvable"], "properties": {"addrs": {"type": "array", "items": {"type": "string"}, "default": ["127.0.0.1", "::1"]}, "timeout": {"type": "integer", "default": "500"}, "meta": {}, "server": {"default": "8.8.8.8", "type": "string"}, "resolvable": {"default": "1", "type": "boolean"}}}, "fileTest": {"required": ["exists"], "properties": {"exists": {"default": "1", "type": "boolean"}, "filetype": {"enum": ["file", "symlink", "directory"], "default": "file", "type": "string"}, "sha512": {"default": "cb71b1940dc879a3688bd502846bff6316dd537bbe917484964fe0f098e9245d80958258dc3bd6297bf42d5bd978cbe2c03d077d4ed45b2b1ed9cd831ceb1bd0", "type": "string"}, "md5": {"default": "7c9bb14b3bf178e82c00c2a4398c93cd", "type": "string"}, "mode": {"default": "0644", "type": "string"}, "size": {"type": "integer", "default": "2118"}, "sha256": {"type": "string", "default": "7f78ce27859049f725936f7b52c6e25d774012947d915e7b394402cfceb70c4c"}, "owner": {"type": "string", "default": "root"}, "skip": {"default": "", "type": "boolean"}, "group": {"type": "string", "default": "root"}, "meta": {}, "linked-to": {"default": "/usr/sbin/sendmail.sendmail", "type": "string"}, "contains": {"items": {"type": "string"}, "type": "array"}}}, "userTest": {"required": ["exists"], "properties": {"shell": {"default": "/sbin/nologin", "type": "string"}, "gid": {"anyOf": [{}, {"type": "integer", "default": "65534"}]}, "groups": {"anyOf": [{}, {"default": ["nfsnobody"], "items": {"type": "string"}, "type": "array"}]}, "skip": {"type": "boolean", "default": ""}, "home": {"anyOf": [{}, {"type": "string", "default": "/var/lib/nfs"}]}, "exists": {"default": "1", "type": "boolean"}, "uid": {"anyOf": [{}, {"default": "65534", "type": "integer"}]}, "meta": {}}}, "addrTest": {"properties": {"local-address": {"type": "string", "default": "127.0.0.1"}, "reachable": {"default": "1", "type": "boolean"}, "timeout": {"default": "500", "examples": ["500"], "type": "integer"}, "meta": {}}, "required": ["reachable", "timeout"]}, "meta": {"type": "object"}, "matchingTest": {"properties": {"meta": {}, "matches": {"anyOf": [{"type": "integer"}, {"type": "object"}, {"type": "array"}]}, "content": {"anyOf": [{"default": "some string", "type": "string"}, {"type": "array", "default": ["2"]}, {"type": "object", "default": {"baz": "ring", "foo": "bar"}}]}}}, "httpTest": {"properties": {"request-headers": {"type": "array", "default": ["Content-Type: text/html"], "items": {"type": "string"}}, "headers": {"type": "array", "default": [], "items": {"type": "string"}}, "skip": {"default": "", "type": "boolean"}, "allow-insecure": {"default": "", "type": "boolean"}, "body": {"type": "array"}, "cert-file": {"default": "", "type": "string"}, "request-body": {"type": "object", "default": "{\"key\": \"value\"}"}, "no-follow-redirects": {"default": "", "type": "boolean"}, "timeout": {"default": "1000", "type": "integer"}, "status": {"type": "integer", "default": "200"}, "proxy": {"default": "", "type": "string"}, "method": {"default": "PUT", "enum": ["GET", "PUT", "HEAD", "POST", "DELETE", "PATCH", "CONNECT", "OPTIONS", "TRACE"], "type": "string"}, "key-file": {"type": "string", "default": ""}, "ca-file": {"default": "", "type": "string"}, "username": {"type": "string", "default": ""}, "meta": {}, "password": {"default": "", "type": "string"}}, "required": ["status"]}}, "properties": {"mount": {"type": "object", "additionalProperties": {}}, "service": {"additionalProperties": {}, "type": "object"}, "user": {"additionalProperties": {}, "type": "object"}, "addr": {"type": "object", "examples": [{"tcp://ip-address-or-domain-name:80": {"reachable": "1", "timeout": "500", "local-address": "127.0.0.1"}}], "additionalProperties": {}}, "file": {"type": "object", "additionalProperties": {}}, "group": {"additionalProperties": {}, "type": "object"}, "gossfile": {"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 <a href=\"#render-r---render-gossfile-after-importing-all-referenced-gossfiles\">render</a> for more examples. Glob patterns can be also be used to specify matching gossfiles.</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">gossfile</span>:\n <span class=\"pl-ent\">myapplication</span>:\n <span class=\"pl-ent\">file</span>: <span class=\"pl-s\">myapp_gossfile.yaml</span>\n <span class=\"pl-ent\">skip</span>: <span class=\"pl-c1\">false</span>\n <span class=\"pl-s\">*.yaml:</span>\n <span class=\"pl-ent\">skip</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">goss_httpd.yaml</span>: <span class=\"pl-s\">{}</span>\n <span class=\"pl-ent\">/etc/goss.d/*.yaml</span>: <span class=\"pl-s\">{}</span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <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:\n myapplication:\n file: myapp_gossfile.yaml\n skip: false\n *.yaml:\n skip: true\n goss_httpd.yaml: {}\n /etc/goss.d/*.yaml: {}\" tabindex=\"0\" role=\"button\" style=\"display: none;\">\n <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\">\n <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>\n</svg>\n <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\">\n <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>\n</svg>\n </clipboard-copy>\n </div></div>\n<p dir=\"auto\">You can specify the gossfile(s) either as the resource key, or using the 'file' attribute.</p>\n<p dir=\"auto\">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.</p>\n", "type": "object", "additionalProperties": {}}, "process": {"additionalProperties": {}, "type": "object"}, "http": {"additionalProperties": {}, "type": "object"}, "command": {"type": "object", "additionalProperties": {}}, "package": {"type": "object", "additionalProperties": {}}, "kernel-param": {"type": "object", "additionalProperties": {}}, "interface": {"additionalProperties": {}, "type": "object"}, "matching": {"type": "object", "x-intellij-html-description": "<p dir=\"auto\">Validates specified content against a matcher. Best used with <a href=\"#templates\">Templates</a>.</p>\n<h4 dir=\"auto\"><a id=\"user-content-with-templates\" class=\"anchor\" aria-hidden=\"true\" href=\"#with-templates\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>With <a href=\"#templates\">Templates</a>:</h4>\n<p dir=\"auto\">Let's say we have a <code>data.json</code> file that gets generated as part of some testing pipeline:</p>\n<div class=\"highlight highlight-source-json notranslate position-relative overflow-auto\" dir=\"auto\"><pre>{\n <span class=\"pl-ent\">\"instance_count\"</span>: <span class=\"pl-c1\">14</span>,\n <span class=\"pl-ent\">\"failures\"</span>: <span class=\"pl-c1\">3</span>,\n <span class=\"pl-ent\">\"status\"</span>: <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>FAIL<span class=\"pl-pds\">\"</span></span>\n}</pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <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=\"{\n "instance_count": 14,\n "failures": 3,\n "status": "FAIL"\n}\" tabindex=\"0\" role=\"button\">\n <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\">\n <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>\n</svg>\n <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\">\n <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>\n</svg>\n </clipboard-copy>\n </div></div>\n<p dir=\"auto\">This could then be passed into goss: <code>goss --vars data.json validate</code></p>\n<p dir=\"auto\">And then validated against:</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">matching</span>:\n <span class=\"pl-ent\">check_instance_count</span>: <span class=\"pl-c\"><span class=\"pl-c\">#</span> Make sure there is at least one instance</span>\n <span class=\"pl-ent\">content</span>: <span class=\"pl-s\">{{ .Vars.instance_count }}</span>\n <span class=\"pl-ent\">matches</span>:\n <span class=\"pl-ent\">gt</span>: <span class=\"pl-c1\">0</span>\n\n <span class=\"pl-ent\">check_failure_count_from_all_instance</span>: <span class=\"pl-c\"><span class=\"pl-c\">#</span> expect no failures</span>\n <span class=\"pl-ent\">content</span>: <span class=\"pl-s\">{{ .Vars.failures }}</span>\n <span class=\"pl-ent\">matches</span>: <span class=\"pl-c1\">0</span>\n\n <span class=\"pl-ent\">check_status</span>:\n <span class=\"pl-ent\">content</span>: <span class=\"pl-s\">{{ .Vars.status }}</span>\n <span class=\"pl-ent\">matches</span>:\n - <span class=\"pl-ent\">not</span>: <span class=\"pl-s\">FAIL</span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <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=\"matching:\n check_instance_count: # Make sure there is at least one instance\n content: {{ .Vars.instance_count }}\n matches:\n gt: 0\n\n check_failure_count_from_all_instance: # expect no failures\n content: {{ .Vars.failures }}\n matches: 0\n\n check_status:\n content: {{ .Vars.status }}\n matches:\n - not: FAIL\" tabindex=\"0\" role=\"button\" style=\"display: none;\">\n <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\">\n <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>\n</svg>\n <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\">\n <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>\n</svg>\n </clipboard-copy>\n </div></div>\n<h4 dir=\"auto\"><a id=\"user-content-without-templates\" class=\"anchor\" aria-hidden=\"true\" href=\"#without-templates\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Without <a href=\"#templates\">Templates</a>:</h4>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">matching</span>:\n <span class=\"pl-ent\">has_substr</span>: <span class=\"pl-c\"><span class=\"pl-c\">#</span> friendly test name</span>\n <span class=\"pl-ent\">content</span>: <span class=\"pl-s\">some string</span>\n <span class=\"pl-ent\">matches</span>:\n <span class=\"pl-ent\">match-regexp</span>: <span class=\"pl-s\">some str</span>\n <span class=\"pl-ent\">has_2</span>:\n <span class=\"pl-ent\">content</span>:\n - <span class=\"pl-c1\">2</span>\n <span class=\"pl-ent\">matches</span>:\n <span class=\"pl-ent\">contain-element</span>: <span class=\"pl-c1\">2</span>\n <span class=\"pl-ent\">has_foo_bar_and_baz</span>:\n <span class=\"pl-ent\">content</span>:\n <span class=\"pl-ent\">foo</span>: <span class=\"pl-s\">bar</span>\n <span class=\"pl-ent\">baz</span>: <span class=\"pl-s\">bing</span>\n <span class=\"pl-ent\">matches</span>:\n <span class=\"pl-ent\">and</span>:\n - <span class=\"pl-ent\">have-key-with-value</span>:\n <span class=\"pl-ent\">foo</span>: <span class=\"pl-s\">bar</span>\n - <span class=\"pl-ent\">have-key</span>: <span class=\"pl-s\">baz</span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <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=\"matching:\n has_substr: # friendly test name\n content: some string\n matches:\n match-regexp: some str\n has_2:\n content:\n - 2\n matches:\n contain-element: 2\n has_foo_bar_and_baz:\n content:\n foo: bar\n baz: bing\n matches:\n and:\n - have-key-with-value:\n foo: bar\n - have-key: baz\" tabindex=\"0\" role=\"button\" style=\"display: none;\">\n <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\">\n <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>\n</svg>\n <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\">\n <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>\n</svg>\n </clipboard-copy>\n </div></div>\n\nadditionalProperties:\n$ref: \"#/definitions/matchTest\"\n"}, "dns": {"x-intellij-html-description": "<p dir=\"auto\">Validates that the provided address is resolvable and the addrs it resolves to.</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">dns</span>:\n <span class=\"pl-ent\">localhost</span>:\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> required attributes</span>\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> optional attributes</span>\n <span class=\"pl-ent\">addrs</span>:\n - <span class=\"pl-s\">127.0.0.1</span>\n - <span class=\"pl-s\">::1</span>\n <span class=\"pl-ent\">server</span>: <span class=\"pl-s\">8.8.8.8 </span><span class=\"pl-c\"><span class=\"pl-c\">#</span> Also supports server:port</span>\n <span class=\"pl-ent\">timeout</span>: <span class=\"pl-c1\">500</span> <span class=\"pl-c\"><span class=\"pl-c\">#</span> in milliseconds (Only used when server attribute is provided)</span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <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:\n localhost:\n # required attributes\n resolvable: true\n # optional attributes\n addrs:\n - 127.0.0.1\n - ::1\n server: 8.8.8.8 # Also supports server:port\n timeout: 500 # in milliseconds (Only used when server attribute is provided)\" tabindex=\"0\" role=\"button\" style=\"display: none;\">\n <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\">\n <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>\n</svg>\n <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\">\n <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>\n</svg>\n </clipboard-copy>\n </div></div>\n<p dir=\"auto\">It is possible to validate the following types of DNS records, but requires the <code>server</code> attribute be set:</p>\n<ul dir=\"auto\">\n<li>A</li>\n<li>AAAA</li>\n<li>CAA</li>\n<li>CNAME</li>\n<li>MX</li>\n<li>NS</li>\n<li>PTR</li>\n<li>SRV</li>\n<li>TXT</li>\n</ul>\n<p dir=\"auto\">To validate specific DNS address types, prepend the hostname with the type and a colon, a few examples:</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">dns</span>:\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> Validate a CNAME record</span>\n <span class=\"pl-ent\">CNAME:c.dnstest.io</span>:\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">server</span>: <span class=\"pl-s\">208.67.222.222</span>\n <span class=\"pl-ent\">addrs</span>:\n - <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>a.dnstest.io.<span class=\"pl-pds\">\"</span></span>\n\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> Validate a PTR record</span>\n <span class=\"pl-ent\">PTR:8.8.8.8</span>:\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">server</span>: <span class=\"pl-s\">8.8.8.8</span>\n <span class=\"pl-ent\">addrs</span>:\n - <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>dns.google.<span class=\"pl-pds\">\"</span></span>\n\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> Validate and SRV record</span>\n <span class=\"pl-ent\">SRV:_https._tcp.dnstest.io</span>:\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">server</span>: <span class=\"pl-s\">208.67.222.222</span>\n <span class=\"pl-ent\">addrs</span>:\n - <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>0 5 443 a.dnstest.io.<span class=\"pl-pds\">\"</span></span>\n - <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>10 10 443 b.dnstest.io.<span class=\"pl-pds\">\"</span></span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <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:\n # Validate a CNAME record\n CNAME:c.dnstest.io:\n resolvable: true\n server: 208.67.222.222\n addrs:\n - "a.dnstest.io."\n\n # Validate a PTR record\n PTR:8.8.8.8:\n resolvable: true\n server: 8.8.8.8\n addrs:\n - "dns.google."\n\n # Validate and SRV record\n SRV:_https._tcp.dnstest.io:\n resolvable: true\n server: 208.67.222.222\n addrs:\n - "0 5 443 a.dnstest.io."\n - "10 10 443 b.dnstest.io."\" tabindex=\"0\" role=\"button\">\n <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\">\n <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>\n</svg>\n <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\">\n <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>\n</svg>\n </clipboard-copy>\n </div></div>\n<p dir=\"auto\">Please note that if you want <code>localhost</code> to <strong>only</strong> resolve <code>127.0.0.1</code> you'll need to use <a href=\"#advanced-matchers\">Advanced Matchers</a></p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">dns</span>:\n <span class=\"pl-ent\">localhost</span>:\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">addrs</span>:\n <span class=\"pl-ent\">consist-of</span>: <span class=\"pl-s\">[127.0.0.1]</span>\n <span class=\"pl-ent\">timeout</span>: <span class=\"pl-c1\">500</span> <span class=\"pl-c\"><span class=\"pl-c\">#</span> in milliseconds</span>\n", "type": "object", "additionalProperties": {}}, "port": {"x-intellij-html-description": "<p dir=\"auto\">Validates the state of a local port.</p>\n<p dir=\"auto\"><strong>Note:</strong> Goss might consider your port to be listening on <code>tcp6</code> rather than <code>tcp</code>, try running <code>goss add port ..</code> to see how goss detects it. (<a href=\"https://github.com/goss-org/goss/issues/149\" data-hovercard-type=\"issue\" data-hovercard-url=\"/goss-org/goss/issues/149/hovercard\">explanation</a>)</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">port</span>:\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> {tcp,tcp6,udp,udp6}:port_num</span>\n <span class=\"pl-ent\">tcp:22</span>:\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> required attributes</span>\n <span class=\"pl-ent\">listening</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> optional attributes</span>\n <span class=\"pl-ent\">ip</span>: <span class=\"pl-c\"><span class=\"pl-c\">#</span> what IP(s) is it listening on</span>\n - <span class=\"pl-s\">0.0.0.0</span>\n <span class=\"pl-ent\">skip</span>: <span class=\"pl-c1\">false</span>\n", "type": "object", "additionalProperties": {}}}, "$schema": "http://json-schema.org/draft-07/schema#"}
|
|
goss-json-schema.json
|
timeout
|
in milliseconds
|
{"type": "integer"}
|
goss-json-schema.json
|
stdout
|
can be a string or pattern, see https://github.com/goss-org/goss/blob/master/docs/manual.md#patterns
|
{"type": "array", "items": {"type": "string"}}
|
goss-json-schema.json
|
stderr
|
can be a string or pattern, see https://github.com/goss-org/goss/blob/master/docs/manual.md#patterns
|
{"type": "array", "items": {"type": "string"}}
|
goss-json-schema.json
|
exit-status
|
Validates the exit-status and output of a command
|
{"type": "integer"}
|
goss-json-schema.json
|
exec
|
command to execute, defaults to the hash key
|
{"type": "string"}
|
goss-json-schema.json
|
usage
|
% of blocks used in this mountpoint
|
{"type": "object", "properties": {"lt": {"default": "95", "type": "integer"}}}
|
goss-json-schema.json
|
ip
|
what IP(s) is it listening on
|
{"type": "array", "default": ["0.0.0.0"], "items": {"type": "string"}}
|
goss-json-schema.json
|
kernelParamTest
|
To see the full list of current values, run sysctl -a.
|
{"properties": {"meta": {}, "value": {"default": "Linux", "type": "string"}}, "required": ["value"]}
|
goss-json-schema.json
|
addrs
|
list of addresses e.g. ["127.0.0.1", "::1"]
|
{"type": "array", "items": {"type": "string"}, "default": ["127.0.0.1", "::1"]}
|
goss-json-schema.json
|
timeout
|
in milliseconds (Only used when server attribute is provided)
|
{"type": "integer", "default": "500"}
|
goss-json-schema.json
|
server
|
Eg 8.8.8.8. Also supports server:port
|
{"default": "8.8.8.8", "type": "string"}
|
goss-json-schema.json
|
sha512
|
A stronger checksum alternatives to md5 (recommended)
|
{"default": "cb71b1940dc879a3688bd502846bff6316dd537bbe917484964fe0f098e9245d80958258dc3bd6297bf42d5bd978cbe2c03d077d4ed45b2b1ed9cd831ceb1bd0", "type": "string"}
|
goss-json-schema.json
|
md5
|
md5 checksum of file
|
{"default": "7c9bb14b3bf178e82c00c2a4398c93cd", "type": "string"}
|
goss-json-schema.json
|
size
|
in bytes
|
{"type": "integer", "default": "2118"}
|
goss-json-schema.json
|
sha256
|
A stronger checksum alternatives to md5 (recommended)
|
{"type": "string", "default": "7f78ce27859049f725936f7b52c6e25d774012947d915e7b394402cfceb70c4c"}
|
goss-json-schema.json
|
contains
|
Check file content for these patterns. can be a string or a pattern
|
{"items": {"type": "string"}, "type": "array"}
|
goss-json-schema.json
|
items
|
string or patterns
|
{"type": "string"}
|
goss-json-schema.json
|
meta
|
meta (arbitrary data) attributes are persisted when adding other resources with goss add
|
{"type": "object"}
|
goss-json-schema.json
|
request-headers
|
Set request header values, e.g. [ "Content-Type: text/html" ]
|
{"type": "array", "default": ["Content-Type: text/html"], "items": {"type": "string"}}
|
goss-json-schema.json
|
headers
|
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.
|
{"type": "array", "default": [], "items": {"type": "string"}}
|
goss-json-schema.json
|
body
|
Check http response content for these patterns
|
{"type": "array"}
|
goss-json-schema.json
|
cert-file
|
certificate file to use for authentication (used with key-file)
|
{"default": "", "type": "string"}
|
goss-json-schema.json
|
request-body
|
request body
|
{"type": "object", "default": "{\"key\": \"value\"}"}
|
goss-json-schema.json
|
no-follow-redirects
|
Setting this to true will NOT follow redirects
|
{"default": "", "type": "boolean"}
|
goss-json-schema.json
|
proxy
|
proxy server to proxy traffic through. Proxy can also be set with environment variables http_proxy.
|
{"default": "", "type": "string"}
|
goss-json-schema.json
|
method
|
http method
|
{"default": "PUT", "enum": ["GET", "PUT", "HEAD", "POST", "DELETE", "PATCH", "CONNECT", "OPTIONS", "TRACE"], "type": "string"}
|
goss-json-schema.json
|
key-file
|
private-key file to use for authentication (used with cert-file)
|
{"type": "string", "default": ""}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.