docs » SpoonInstall

Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.

Table containing the list of available Spoon repositories.

• The key of each entry is an identifier for the repository, and its value is a table with the following entries:
• desc - Human-readable description for the repository
• branch - Active git branch for the Spoon files
• url - Base URL for the repository. For now the repository is assumed to be hosted in GitHub, and the URL should be the main base URL of the repository. Repository metadata needs to be stored under docs/docs.json, and the Spoon zip files need to be stored under Spoons/.
• Default value:

{
   default = {
      url = "https://github.com/Hammerspoon/Spoons",
      desc = "Main Hammerspoon Spoon repository",
      branch = "master",
   }
}

If true, andUse() will update repos and install packages synchronously. Defaults to false.

• Keep in mind that if you set this to true, Hammerspoon will block until all missing Spoons are installed, but the notifications will happen at a more "human readable" rate.

Declaratively install, load and configure a Spoon

• name - the name of the Spoon to install (without the .spoon extension). If the Spoon is already installed, it will be loaded using hs.loadSpoon(). If it is not installed, it will be installed using SpoonInstall:asyncInstallSpoonFromRepo() and then loaded.
• arg - if provided, can be used to specify the configuration of the Spoon. The following keys are recognized (all are optional):
  • repo - repository from where the Spoon should be installed if not present in the system, as defined in SpoonInstall.repos. Defaults to "default".
  • config - a table containing variables to be stored in the Spoon object to configure it. For example, config = { answer = 42 } will result in spoon.<LoadedSpoon>.answer being set to 42.
  • hotkeys - a table containing hotkey bindings. If provided, will be passed as-is to the Spoon's bindHotkeys() method. The special string "default" can be given to use the Spoons defaultHotkeys variable, if it exists.
  • fn - a function which will be called with the freshly-loaded Spoon object as its first argument.
  • loglevel - if the Spoon has a variable called logger, its setLogLevel() method will be called with this value.
  • start - if true, call the Spoon's start() method after configuring everything else.
  • disable - if true, do nothing. Easier than commenting it out when you want to temporarily disable a spoon.

• None

Asynchronously install a Spoon from a registered repository

• name - Name of the Spoon to install.
• repo - Name of the repository to use. Defaults to "default"
• callback - if given, a function to call after the installation finishes (also if it fails). The function receives the following arguments:
  • urlparts - Result of calling hs.http.urlParts on the URL of the Spoon zip file
  • success - boolean indicating whether the installation was successful

• true if the installation was correctly initiated (i.e. the repo and spoon name were correct), false otherwise.

Asynchronously download a Spoon zip file and install it.

• url - URL of the zip file to install.
• callback - if given, a function to call after the installation finishes (also if it fails). The function receives the following arguments:
  • urlparts - Result of calling hs.http.urlParts on the URL of the Spoon zip file
  • success - boolean indicating whether the installation was successful

• true if the installation was correctly initiated (i.e. the URL is valid), false otherwise

Asynchronously fetch the information about the contents of all Spoon repositories registered in SpoonInstall.repos

• None

• None

• For now, the repository data is not persisted, so you need to update it after every restart if you want to use any of the install functions.

Asynchronously fetch the information about the contents of a Spoon repository

• repo - name of the repository to update. Defaults to "default".
• callback - if given, a function to be called after the update finishes (also if it fails). The function will receive the following arguments:
  • repo - name of the repository
  • success - boolean indicating whether the update succeeded

• true if the update was correctly initiated (i.e. the repo name is valid), nil otherwise

• For now, the repository data is not persisted, so you need to update it after every restart if you want to use any of the install functions.

Synchronously install a Spoon from a registered repository

• name = Name of the Spoon to install.
• repo - Name of the repository to use. Defaults to "default"

• true if the installation was successful, nil otherwise.

Synchronously download a Spoon zip file and install it.

• url - URL of the zip file to install.

• true if the installation was successful, nil otherwise

Return a sorted list of registered Spoon repositories

• None

• Table containing a list of strings with the repository identifiers

Search repositories for a pattern

• pat - Lua pattern that will be matched against the name and description of each spoon in the registered repositories. All text is converted to lowercase before searching it, so you can use all-lowercase in your pattern.

• Table containing a list of matching entries. Each entry is a table with the following keys:
  • name - Spoon name
  • desc - description of the spoon
  • repo - identifier in the repository where the match was found

Synchronously fetch the information about the contents of all Spoon repositories registered in SpoonInstall.repos

• None

• None

• This is a synchronous call, which means Hammerspoon will be blocked until it finishes.
• For now, the repository data is not persisted, so you need to update it after every restart if you want to use any of the install functions.

Synchronously fetch the information about the contents of a Spoon repository

• repo - name of the repository to update. Defaults to "default".

• true if the update was successful, nil otherwise

• This is a synchronous call, which means Hammerspoon will be blocked until it finishes. For use in your configuration files, it's advisable to use SpoonInstall.asyncUpdateRepo() instead.
• For now, the repository data is not persisted, so you need to update it after every restart if you want to use any of the install functions.