soulshack

 //  ____                    _   ____    _                      _
// / ___|    ___    _   _  | | / ___|  | |__     __ _    ___  | | __
// ___    / _   | | | | | | ___   | '_    / _` |  / __| | |/ /
//  ___) | | (_) | | |_| | | |  ___) | | | | | | (_| | | (__  |   <
// |____/   ___/   __,_| |_| |____/  |_| |_|  __,_|  ___| |_|_
//  .  .  .  because  real  people  are  overrated

soulshack es un bot de chat irc que utiliza un punto final de API openai para generar respuestas similares a las humanas.

características

• se conecta a un servidor irc y se une a un canal específico
• Utiliza la API de Openai y puntos finales compatibles como ollama.
• permite la configuración dinámica de la configuración del bot a través de comandos
• admite autenticación SSL y SASL para servidores IRC
• llamada de herramientas, herramientas de ejemplo, herramientas de gestión de canales

edificio

go build . 

 docker build . -t soulshack:dev

uso

soulshack --nick chatbot --server irc.freenode.net --port 6697 --channel ' #soulshack ' --ssl --apikey **************** 

configuración

soulshack se puede configurar mediante indicadores de línea de comando, variables de entorno o archivos de configuración.

banderas

 Usage:
  soulshack --channel <channel> [--nick <nickname>] [--server <server>] [--port <port>] [--tls] [--apikey <key>] [flags]

Examples:
soulshack --nick chatbot --server irc.freenode.net --port 6697 --channel '#soulshack' --tls --apikey ****************

Flags:
  -a, --addressed                  require bot be addressed by nick for response (default true)
  -A, --admins strings             comma-separated list of allowed hostmasks (e.g. alex!~alex@localhost, josh!~josh@localhost).
  -t, --apitimeout duration        timeout for each completion request (default 5m0s)
  -c, --channel string             irc channel to join
  -C, --chunkdelay duration        after this delay, bot will look to split the incoming buffer on sentence boundaries (default 15s)
  -m, --chunkmax int               maximum number of characters to send as a single message (default 350)
  -b, --config string              use the named configuration file
      --greeting string            prompt to be used when the bot joins the channel (default "hello.")
  -h, --help                       help for soulshack
      --maxtokens int              maximum number of tokens to generate (default 512)
      --model string               model to be used for responses (default "gpt-4o")
  -n, --nick string                bot's nickname on the irc server (default "soulshack")
      --apikey string           openai api key
      --apiurl string           alternative base url to use instead of openai
  -p, --port int                   irc server port (default 6667)
      --prompt string              initial system prompt (default "you are a helpful chatbot. do not use caps. do not use emoji.")
      --saslnick string            nick used for SASL
      --saslpass string            password for SASL plain
  -s, --server string              irc server address (default "localhost")
  -S, --sessionduration duration   duration for the chat session; message context will be cleared after this time (default 3m0s)
  -H, --sessionhistory int         maximum number of lines of context to keep per session (default 50)
      --temperature float32        temperature for the completion (default 0.7)
  -e, --tls                        enable TLS for the IRC connection
      --tlsinsecure                skip TLS certificate verification
      --tools                      enable tool use (default false)
      --toolsdir                   directory to load tools from (default "examples/tools")
      --top_p float32              top P value for the completion (default 1)
  -v, --verbose                    enable verbose logging of sessions and configuration
      --version                    version for soulshack

variables de entorno

Todos los indicadores también se pueden configurar mediante variables de entorno con el prefijo soulshack_ . por ejemplo, soulshack_server para el indicador --server .

archivos de configuración

Los archivos de configuración utilizan el formato yaml. se pueden cargar usando el indicador --config . un archivo de configuración puede contener cualquiera de las configuraciones que se pueden establecer mediante indicadores.

agregando una configuración

Para utilizar la creación de un nuevo archivo de configuración, siga estos pasos:

1. cree un nuevo archivo yml con el nombre deseado (por ejemplo, marvin.yml ).
2. agregue la configuración que desee al archivo yml. Por ejemplo:

 nick : marvin
greeting : " explain the size of your brain compared to common household objects. "
prompt : " you are marvin the paranoid android. respond with a short text message: "
channel : " #marvinshouse "
server : localhost 

soulshack --config /path/to/marvin.yml 

comandos

• /set : establece un parámetro de configuración (por ejemplo, /set nick newnick )
• /get : obtiene el valor actual de un parámetro de configuración (por ejemplo, /get nick )
• /leave : hace que el bot abandone el canal y salga
• /help : muestra ayuda para los comandos disponibles

herramientas

coloque un ejecutable o script en la ubicación de su directorio de herramientas. para que quede registrado debe responder a los siguientes comandos:

• --schema: genera un esquema JSON que describe el uso de la herramienta.
• --execute $json: se llamará con JSON que coincida con su esquema

Intente asegurarse de que llm no pueda inyectar algo en el json de ejecución que arruine su vida. porque no puedes confiar en los bots ni en las personas que los usan.

Para ser honesto, no deberías hacer esto con scripts de shell, es una especie de campo minado. así que aquí hay un script de shell

 set -e

# Check if --schema argument is provided
if [[ " $1 " == " --schema " ]] ; then
  # Output a JSON schema to describe the tool
  # shellcheck disable=SC2016
  cat << EOF
  {
  "name": "get_current_date_with_format",
  "description": "provides the current time and date in the specified unix date command format",
  "type": "object",
  "properties": {
    "format": {
      "type": "string",
      "description": "The format for the date. use unix date command format (e.g., +%Y-%m-%d %H:%M:%S). always include the leading + sign."
    }
  },
  "required": ["format"],
  "additionalProperties": false
  }
EOF
  exit 0
fi



if [[ " $1 " == " --execute " ]] ; then
  # Ensure jq is available
  if ! command -v jq & > /dev/null ; then
    echo " Error: jq is not installed. " >&2
    exit 1
  fi

  # Extract format field from JSON
  format= $( jq -r ' .format ' <<< " $2 " )

  # Sanitize the format string
  if [[ " $format " =~ [^a-zA-Z0-9%+:/  - ] ]] ; then
    echo " Error: Invalid characters in format string. " >&2
    exit 1
  fi

  # Use -- to prevent option parsing
  date_output= $( date -- " $format " )
  echo " $date_output "
  exit 0
fi


# if no arguments, show usage
# shellcheck disable=SC2140
echo " Usage: currentdate.sh [--schema | --execute '{ " format " : " +%Y-%m-%d %H:%M:%S " }'] " 

nombrado como homenaje a mi viejo amigo dayv, sp0t, en quien pienso a menudo