Golem

admin

Perform Administrative tasks.

Subcommands

  • librefresh: Refresh all libraries, reading in new listings.
  • bugs: View last 5 bug reports.

alias

Interact with the aliases registered for this server.

Subcommands

  • create: Create a new alias.

    Arguments

    • aliascommand* - string: A valid GolemAlias string. "aliasName => $go command"
  • delete: Delete an alias by name.

    Arguments

    • aliasname* - string: The name of the alias to delete.
  • list: List aliases registered to this server.

get

Retrieve information about the current Golem instance.

Arguments

  • value - string: The property to get information about.

mix LastFm

Enqueue a selection of tracks mixed off the current playing track. Can mix by either like artist or like tracks, defaulting to artist if no argument is provided.

Arguments

  • mixtype - string: What property of the current track to mix off of.

pause Music*Youtube*

Pause the current playback.

peek Music*Youtube*

See the next tracks in the queue.

perms

View and modify user permissions.

Subcommands

  • describe: View all grantable permissions.
  • get: View permissions for a user

    Arguments

    • user* - user: The user to fetch permissions for.
  • set: Set the permissions for a user.

    Arguments

    • user* - user: The user whose permissions are being set.
    • permissions* - string: The permissions to set, space delimited. Overwrites existing permissions.
  • add: Grant a permission to a user

    Arguments

    • user* - user: The user to grant permissions to.
    • permission* - string: The permission to grant.
  • remove: Remove a permission from a user

    Arguments

    • user* - user: The user to remove permissions from.
    • permission* - string: The permissions to remove.

play Music*Youtube*

Play a Local Track retrieved via searching for the provided query, a YouTube track retrievied via YouTube search if the Local Track search misses; A YouTube Track from a provided absolute url; A YouTube playlist from a provided absolute YouTube Playlist URL.

Arguments

  • query* - string: The track to search for and play|A YouTube video/playlist URL to play.

playlist PlexMusic

Play a given playlist by name. Presents a select of all playlists if no playlist name is provided. Requires enabling the Plex module and a local Plex Media Server.

Arguments

  • playlist - string: The name of the playlist to queue.

playnext Music*Youtube*

Execute a Play command, queueing the track ahead of the passive queue, behind other tracks that have been Playnext-ed

Arguments

  • query* - string: The track to search for and play|A YouTube video URL to play.

report

Report bugs you experience while using Golem

Arguments

  • content* - string: What you were doing leading up to the bug & what you expected to happen.

search Music

Search for a local track and view the result set.

Arguments

  • query* - string: The query to run against the Local Search Index.

shuffle Music*Youtube*

Shuffle the current queue maintaining the playnext queue's position.

skip Music*Youtube*

Skip queued tracks.

Arguments

  • skip-count - integer: The number of tracks to skip.

stop Music*Youtube*

Stops the current playback.