[ { "Command": [], "Constant": [], "Constructor": [], "Deprecated": [], "Field": [], "Function": [], "Method": [ { "def": "BrewInfo:bindHotkeys(mapping)", "desc": "Binds hotkeys for BrewInfo", "doc": "Binds hotkeys for BrewInfo\n\nParameters:\n * mapping - A table containing hotkey modifier/key details for the following items:\n * show_brew_info - Show output of `brew info` using the selected text as package name\n * open_brew_url - Open the homepage of the formula whose name is currently selected\n * show_brew_cask_info - Show output of `brew cask info` using the selected text as package name\n * open_brew_cask_url - Open the homepage of the Cask whose name is currently selected", "examples": [], "file": "Source/BrewInfo.spoon//init.lua", "lineno": "166", "name": "bindHotkeys", "notes": [], "parameters": [ " * mapping - A table containing hotkey modifier/key details for the following items:\n * show_brew_info - Show output of `brew info` using the selected text as package name\n * open_brew_url - Open the homepage of the formula whose name is currently selected\n * show_brew_cask_info - Show output of `brew cask info` using the selected text as package name\n * open_brew_cask_url - Open the homepage of the Cask whose name is currently selected" ], "returns": [], "signature": "BrewInfo:bindHotkeys(mapping)", "stripped_doc": "", "type": "Method" }, { "def": "BrewInfo:openBrewURL(pkg, subcommand)", "desc": "Opens the homepage for package `pkg`, as obtained from the `homepage` field in `brew cat `", "doc": "Opens the homepage for package `pkg`, as obtained from the `homepage` field in `brew cat `\n\nParameters:\n * pkg - name of the package to query\n * subcommand - brew subcommand to use for the `cat` command. Defaults to an empty string, which results in \"brew cat \" being run. For example, if `subcommand` is \"cask\", the `brew cask cat ` command will be used.\n\nReturns:\n * The Spoon object", "examples": [], "file": "Source/BrewInfo.spoon//init.lua", "lineno": "126", "name": "openBrewURL", "notes": [], "parameters": [ " * pkg - name of the package to query", " * subcommand - brew subcommand to use for the `cat` command. Defaults to an empty string, which results in \"brew cat \" being run. For example, if `subcommand` is \"cask\", the `brew cask cat ` command will be used." ], "returns": [ " * The Spoon object" ], "signature": "BrewInfo:openBrewURL(pkg, subcommand)", "stripped_doc": "", "type": "Method" }, { "def": "BrewInfo:openBrewURLCurSel(subcommand)", "desc": "Opens the homepage for the currently-selected package, as obtained from the `homepage` field in `brew cat `", "doc": "Opens the homepage for the currently-selected package, as obtained from the `homepage` field in `brew cat `\n\nParameters:\n * subcommand - brew subcommand to use for the `cat` command. Defaults to an empty string, which results in \"brew cat \" being run. For example, if `subcommand` is \"cask\", the `brew cask cat ` command will be used.\n\nReturns:\n * The Spoon object", "examples": [], "file": "Source/BrewInfo.spoon//init.lua", "lineno": "153", "name": "openBrewURLCurSel", "notes": [], "parameters": [ " * subcommand - brew subcommand to use for the `cat` command. Defaults to an empty string, which results in \"brew cat \" being run. For example, if `subcommand` is \"cask\", the `brew cask cat ` command will be used." ], "returns": [ " * The Spoon object" ], "signature": "BrewInfo:openBrewURLCurSel(subcommand)", "stripped_doc": "", "type": "Method" }, { "def": "BrewInfo:showBrewInfo(pkg, subcommand)", "desc": "Displays an alert with the output of `brew info `", "doc": "Displays an alert with the output of `brew info `\n\nParameters:\n * pkg - name of the package to query\n * subcommand - brew subcommand to use for the `info` command. Defaults to an empty string, which results in \"brew info \" being run. For example, if `subcommand` is \"cask\", the `brew cask info ` command will be used.\n\nReturns:\n * The Spoon object", "examples": [], "file": "Source/BrewInfo.spoon//init.lua", "lineno": "89", "name": "showBrewInfo", "notes": [], "parameters": [ " * pkg - name of the package to query", " * subcommand - brew subcommand to use for the `info` command. Defaults to an empty string, which results in \"brew info \" being run. For example, if `subcommand` is \"cask\", the `brew cask info ` command will be used." ], "returns": [ " * The Spoon object" ], "signature": "BrewInfo:showBrewInfo(pkg, subcommand)", "stripped_doc": "", "type": "Method" }, { "def": "BrewInfo:showBrewInfoCurSel(subcommand)", "desc": "Display `brew info` using the selected text as the package name", "doc": "Display `brew info` using the selected text as the package name\n\nParameters:\n * subcommand - brew subcommand to use for the `info` command. Defaults to an empty string, which results in \"brew info\" being run. For example, if `subcommand` is \"cask\", the `brew cask info` command will be used.\n\nReturns:\n * The Spoon object", "examples": [], "file": "Source/BrewInfo.spoon//init.lua", "lineno": "113", "name": "showBrewInfoCurSel", "notes": [], "parameters": [ " * subcommand - brew subcommand to use for the `info` command. Defaults to an empty string, which results in \"brew info\" being run. For example, if `subcommand` is \"cask\", the `brew cask info` command will be used." ], "returns": [ " * The Spoon object" ], "signature": "BrewInfo:showBrewInfoCurSel(subcommand)", "stripped_doc": "", "type": "Method" } ], "Variable": [ { "def": "BrewInfo.brew_info_delay_sec", "desc": "An integer specifying how long the alerts generated by BrewInfo will stay onscreen", "doc": "An integer specifying how long the alerts generated by BrewInfo will stay onscreen", "file": "Source/BrewInfo.spoon//init.lua", "lineno": "30", "name": "brew_info_delay_sec", "signature": "BrewInfo.brew_info_delay_sec", "stripped_doc": "", "type": "Variable" }, { "def": "BrewInfo.brew_info_style", "desc": "A table in conformance with the [hs.alert.defaultStyle](http://www.hammerspoon.org/docs/hs.alert.html#defaultStyle[]) format that specifies the style used by the alerts. Default value: `{ textFont = \"Courier New\", textSize = 14, radius = 10 }`", "doc": "A table in conformance with the [hs.alert.defaultStyle](http://www.hammerspoon.org/docs/hs.alert.html#defaultStyle[]) format that specifies the style used by the alerts. Default value: `{ textFont = \"Courier New\", textSize = 14, radius = 10 }`", "file": "Source/BrewInfo.spoon//init.lua", "lineno": "35", "name": "brew_info_style", "signature": "BrewInfo.brew_info_style", "stripped_doc": "", "type": "Variable" }, { "def": "BrewInfo.brew_path", "desc": "A string specifying the path to the `brew` executable. Defaults to `/usr/local/bin/brew`", "doc": "A string specifying the path to the `brew` executable. Defaults to `/usr/local/bin/brew`", "file": "Source/BrewInfo.spoon//init.lua", "lineno": "25", "name": "brew_path", "signature": "BrewInfo.brew_path", "stripped_doc": "", "type": "Variable" }, { "def": "BrewInfo.select_text_if_needed", "desc": "If `true`, and no text is currently selected in the terminal, issue a double-click to select the text below the cursor, and use that as the input to `brew info`. See also `BrewInfo.select_text_modifiers`. Defaults to `true`.", "doc": "If `true`, and no text is currently selected in the terminal, issue a double-click to select the text below the cursor, and use that as the input to `brew info`. See also `BrewInfo.select_text_modifiers`. Defaults to `true`.", "file": "Source/BrewInfo.spoon//init.lua", "lineno": "44", "name": "select_text_if_needed", "signature": "BrewInfo.select_text_if_needed", "stripped_doc": "", "type": "Variable" }, { "def": "BrewInfo.select_text_modifiers", "desc": "Table containing the modifiers to be used together with a double-click when `BrewInfo.select_text_if_needed` is true. Defaults to `{cmd = true, shift = true}` to issue a Cmd-Shift-double-click, which will select a continuous non-space string in Terminal and iTerm2.", "doc": "Table containing the modifiers to be used together with a double-click when `BrewInfo.select_text_if_needed` is true. Defaults to `{cmd = true, shift = true}` to issue a Cmd-Shift-double-click, which will select a continuous non-space string in Terminal and iTerm2.", "file": "Source/BrewInfo.spoon//init.lua", "lineno": "49", "name": "select_text_modifiers", "signature": "BrewInfo.select_text_modifiers", "stripped_doc": "", "type": "Variable" } ], "desc": "Display pop-up with Homebrew Formula info, or open their URL", "doc": "Display pop-up with Homebrew Formula info, or open their URL\n\nDownload: [https://github.com/Hammerspoon/Spoons/raw/master/Spoons/BrewInfo.spoon.zip](https://github.com/Hammerspoon/Spoons/raw/master/Spoons/BrewInfo.spoon.zip)\n\nYou can bind keys to automatically display the output of `brew\ninfo` of the currently-selected package name, or to open its\nhomepage. I use it to quickly explore new packages from the output\nof `brew update`.", "items": [ { "def": "BrewInfo:bindHotkeys(mapping)", "desc": "Binds hotkeys for BrewInfo", "doc": "Binds hotkeys for BrewInfo\n\nParameters:\n * mapping - A table containing hotkey modifier/key details for the following items:\n * show_brew_info - Show output of `brew info` using the selected text as package name\n * open_brew_url - Open the homepage of the formula whose name is currently selected\n * show_brew_cask_info - Show output of `brew cask info` using the selected text as package name\n * open_brew_cask_url - Open the homepage of the Cask whose name is currently selected", "examples": [], "file": "Source/BrewInfo.spoon//init.lua", "lineno": "166", "name": "bindHotkeys", "notes": [], "parameters": [ " * mapping - A table containing hotkey modifier/key details for the following items:\n * show_brew_info - Show output of `brew info` using the selected text as package name\n * open_brew_url - Open the homepage of the formula whose name is currently selected\n * show_brew_cask_info - Show output of `brew cask info` using the selected text as package name\n * open_brew_cask_url - Open the homepage of the Cask whose name is currently selected" ], "returns": [], "signature": "BrewInfo:bindHotkeys(mapping)", "stripped_doc": "", "type": "Method" }, { "def": "BrewInfo.brew_info_delay_sec", "desc": "An integer specifying how long the alerts generated by BrewInfo will stay onscreen", "doc": "An integer specifying how long the alerts generated by BrewInfo will stay onscreen", "file": "Source/BrewInfo.spoon//init.lua", "lineno": "30", "name": "brew_info_delay_sec", "signature": "BrewInfo.brew_info_delay_sec", "stripped_doc": "", "type": "Variable" }, { "def": "BrewInfo.brew_info_style", "desc": "A table in conformance with the [hs.alert.defaultStyle](http://www.hammerspoon.org/docs/hs.alert.html#defaultStyle[]) format that specifies the style used by the alerts. Default value: `{ textFont = \"Courier New\", textSize = 14, radius = 10 }`", "doc": "A table in conformance with the [hs.alert.defaultStyle](http://www.hammerspoon.org/docs/hs.alert.html#defaultStyle[]) format that specifies the style used by the alerts. Default value: `{ textFont = \"Courier New\", textSize = 14, radius = 10 }`", "file": "Source/BrewInfo.spoon//init.lua", "lineno": "35", "name": "brew_info_style", "signature": "BrewInfo.brew_info_style", "stripped_doc": "", "type": "Variable" }, { "def": "BrewInfo.brew_path", "desc": "A string specifying the path to the `brew` executable. Defaults to `/usr/local/bin/brew`", "doc": "A string specifying the path to the `brew` executable. Defaults to `/usr/local/bin/brew`", "file": "Source/BrewInfo.spoon//init.lua", "lineno": "25", "name": "brew_path", "signature": "BrewInfo.brew_path", "stripped_doc": "", "type": "Variable" }, { "def": "BrewInfo:openBrewURL(pkg, subcommand)", "desc": "Opens the homepage for package `pkg`, as obtained from the `homepage` field in `brew cat `", "doc": "Opens the homepage for package `pkg`, as obtained from the `homepage` field in `brew cat `\n\nParameters:\n * pkg - name of the package to query\n * subcommand - brew subcommand to use for the `cat` command. Defaults to an empty string, which results in \"brew cat \" being run. For example, if `subcommand` is \"cask\", the `brew cask cat ` command will be used.\n\nReturns:\n * The Spoon object", "examples": [], "file": "Source/BrewInfo.spoon//init.lua", "lineno": "126", "name": "openBrewURL", "notes": [], "parameters": [ " * pkg - name of the package to query", " * subcommand - brew subcommand to use for the `cat` command. Defaults to an empty string, which results in \"brew cat \" being run. For example, if `subcommand` is \"cask\", the `brew cask cat ` command will be used." ], "returns": [ " * The Spoon object" ], "signature": "BrewInfo:openBrewURL(pkg, subcommand)", "stripped_doc": "", "type": "Method" }, { "def": "BrewInfo:openBrewURLCurSel(subcommand)", "desc": "Opens the homepage for the currently-selected package, as obtained from the `homepage` field in `brew cat `", "doc": "Opens the homepage for the currently-selected package, as obtained from the `homepage` field in `brew cat `\n\nParameters:\n * subcommand - brew subcommand to use for the `cat` command. Defaults to an empty string, which results in \"brew cat \" being run. For example, if `subcommand` is \"cask\", the `brew cask cat ` command will be used.\n\nReturns:\n * The Spoon object", "examples": [], "file": "Source/BrewInfo.spoon//init.lua", "lineno": "153", "name": "openBrewURLCurSel", "notes": [], "parameters": [ " * subcommand - brew subcommand to use for the `cat` command. Defaults to an empty string, which results in \"brew cat \" being run. For example, if `subcommand` is \"cask\", the `brew cask cat ` command will be used." ], "returns": [ " * The Spoon object" ], "signature": "BrewInfo:openBrewURLCurSel(subcommand)", "stripped_doc": "", "type": "Method" }, { "def": "BrewInfo.select_text_if_needed", "desc": "If `true`, and no text is currently selected in the terminal, issue a double-click to select the text below the cursor, and use that as the input to `brew info`. See also `BrewInfo.select_text_modifiers`. Defaults to `true`.", "doc": "If `true`, and no text is currently selected in the terminal, issue a double-click to select the text below the cursor, and use that as the input to `brew info`. See also `BrewInfo.select_text_modifiers`. Defaults to `true`.", "file": "Source/BrewInfo.spoon//init.lua", "lineno": "44", "name": "select_text_if_needed", "signature": "BrewInfo.select_text_if_needed", "stripped_doc": "", "type": "Variable" }, { "def": "BrewInfo.select_text_modifiers", "desc": "Table containing the modifiers to be used together with a double-click when `BrewInfo.select_text_if_needed` is true. Defaults to `{cmd = true, shift = true}` to issue a Cmd-Shift-double-click, which will select a continuous non-space string in Terminal and iTerm2.", "doc": "Table containing the modifiers to be used together with a double-click when `BrewInfo.select_text_if_needed` is true. Defaults to `{cmd = true, shift = true}` to issue a Cmd-Shift-double-click, which will select a continuous non-space string in Terminal and iTerm2.", "file": "Source/BrewInfo.spoon//init.lua", "lineno": "49", "name": "select_text_modifiers", "signature": "BrewInfo.select_text_modifiers", "stripped_doc": "", "type": "Variable" }, { "def": "BrewInfo:showBrewInfo(pkg, subcommand)", "desc": "Displays an alert with the output of `brew info `", "doc": "Displays an alert with the output of `brew info `\n\nParameters:\n * pkg - name of the package to query\n * subcommand - brew subcommand to use for the `info` command. Defaults to an empty string, which results in \"brew info \" being run. For example, if `subcommand` is \"cask\", the `brew cask info ` command will be used.\n\nReturns:\n * The Spoon object", "examples": [], "file": "Source/BrewInfo.spoon//init.lua", "lineno": "89", "name": "showBrewInfo", "notes": [], "parameters": [ " * pkg - name of the package to query", " * subcommand - brew subcommand to use for the `info` command. Defaults to an empty string, which results in \"brew info \" being run. For example, if `subcommand` is \"cask\", the `brew cask info ` command will be used." ], "returns": [ " * The Spoon object" ], "signature": "BrewInfo:showBrewInfo(pkg, subcommand)", "stripped_doc": "", "type": "Method" }, { "def": "BrewInfo:showBrewInfoCurSel(subcommand)", "desc": "Display `brew info` using the selected text as the package name", "doc": "Display `brew info` using the selected text as the package name\n\nParameters:\n * subcommand - brew subcommand to use for the `info` command. Defaults to an empty string, which results in \"brew info\" being run. For example, if `subcommand` is \"cask\", the `brew cask info` command will be used.\n\nReturns:\n * The Spoon object", "examples": [], "file": "Source/BrewInfo.spoon//init.lua", "lineno": "113", "name": "showBrewInfoCurSel", "notes": [], "parameters": [ " * subcommand - brew subcommand to use for the `info` command. Defaults to an empty string, which results in \"brew info\" being run. For example, if `subcommand` is \"cask\", the `brew cask info` command will be used." ], "returns": [ " * The Spoon object" ], "signature": "BrewInfo:showBrewInfoCurSel(subcommand)", "stripped_doc": "", "type": "Method" } ], "name": "BrewInfo", "stripped_doc": "\nDownload: [https://github.com/Hammerspoon/Spoons/raw/master/Spoons/BrewInfo.spoon.zip](https://github.com/Hammerspoon/Spoons/raw/master/Spoons/BrewInfo.spoon.zip)\n\nYou can bind keys to automatically display the output of `brew\ninfo` of the currently-selected package name, or to open its\nhomepage. I use it to quickly explore new packages from the output\nof `brew update`.", "submodules": [], "type": "Module" } ]