Irccd socket API

This guide will help you controlling irccd via sockets.

Currently, irccd supports internet and unix sockets, you need at least one transport defined in your irccd.conf.

Syntax

Irccd use JSON as protocol for sending and receiving data. A message must ends with \r\n\r\n to be complete, thus it's possible to write JSON messages in multiple lines.

For example, this buffer will be parsed as two different messages.

Responses

All commands emit a response with the following properties:

  • command: (string) the result of the issued command,
  • status: (string) error or ok,
  • error: (string) the error message if status is set to error.