soulshack

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

soulshack est un chatbot irc qui utilise un point de terminaison API openai pour générer des réponses de type humain.

caractéristiques

• se connecte à un serveur irc et rejoint un canal spécifié
• utilise l'API openai et des points de terminaison compatibles comme ollama
• permet la configuration dynamique des paramètres du bot via des commandes
• prend en charge l'authentification SSL et SASL pour les serveurs irc
• appels d'outils, exemples d'outils, outils de gestion de canaux

bâtiment

go build . 

 docker build . -t soulshack:dev

usage

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

configuration

soulshack peut être configuré à l'aide d'indicateurs de ligne de commande, de variables d'environnement ou de fichiers de configuration.

drapeaux

 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 d'environnement

tous les indicateurs peuvent également être définis via des variables d'environnement avec le préfixe soulshack_ . par exemple, soulshack_server pour l'indicateur --server .

fichiers de configuration

les fichiers de configuration utilisent le format yaml. ils peuvent être chargés en utilisant l'indicateur --config . un fichier de configuration peut contenir n'importe lequel des paramètres pouvant être définis via des indicateurs.

ajouter une configuration

pour utiliser créer un nouveau fichier de configuration, suivez ces étapes :

1. créez un nouveau fichier yml avec le nom souhaité (par exemple, marvin.yml ).
2. ajoutez les paramètres souhaités au fichier yml. Par exemple:

 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 

commandes

• /set : définit un paramètre de configuration (par exemple, /set nick newnick )
• /get : récupère la valeur actuelle d'un paramètre de configuration (par exemple, /get nick )
• /leave : fait que le bot quitte le canal et quitte
• /help : affiche l'aide pour les commandes disponibles

outils

placez un exécutable ou un script dans votre répertoire d'outils. pour qu'il soit enregistré, il doit répondre aux commandes suivantes :

• --schema : génère un schéma JSON décrivant l'utilisation de l'outil.
• --execute $json : sera appelé avec JSON correspondant à votre schéma

essayez de vous assurer que le llm ne peut pas injecter quelque chose dans le json d'exécution qui ruinerait votre vie. parce que vous ne pouvez pas faire confiance aux robots ou aux personnes qui les utilisent.

pour être honnête, vous ne devriez pas faire cela avec des scripts shell, c'est une sorte de champ de mines. voici donc un script 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 " }'] " 

nommé en hommage à mon vieil ami Dayv, sp0t, à qui je pense souvent