Merge branch 'develop' into ng/moving-readmes

Author: odilitime

.env.example

@@ -9,6 +9,7 @@ PGLITE_DATA_DIR=     #../pgLite/ if selecting a directory   --- or memory:// if
 
 # Eliza Port Config
 SERVER_PORT=3000
+VITE_SERVER_PORT=${SERVER_PORT}
 
 # Supabase Configuration
 SUPABASE_URL=
@@ -602,3 +603,16 @@ AKASH_MANIFEST_VALIDATION_LEVEL=strict
 # Quai Network Ecosystem
 QUAI_PRIVATE_KEY=
 QUAI_RPC_URL=https://rpc.quai.network
+
+# Instagram Configuration
+INSTAGRAM_DRY_RUN=false
+INSTAGRAM_USERNAME=               # Account username
+INSTAGRAM_PASSWORD=               # Account password
+INSTAGRAM_APP_ID=                 # Instagram App ID is required
+INSTAGRAM_APP_SECRET=             # Instagram App Secret is required
+INSTAGRAM_BUSINESS_ACCOUNT_ID=    # Optional Business Account ID for additional features
+INSTAGRAM_POST_INTERVAL_MIN=60    # Default: 60 minutes
+INSTAGRAM_POST_INTERVAL_MAX=120   # Default: 120 minutes
+INSTAGRAM_ENABLE_ACTION_PROCESSING=false  # Enable/disable action processing
+INSTAGRAM_ACTION_INTERVAL=5       # Interval between actions in minutes
+INSTAGRAM_MAX_ACTIONS=1          # Maximum number of actions to process at once

agent/package.json

@@ -30,6 +30,7 @@
         "@elizaos/client-lens": "workspace:*",
         "@elizaos/client-telegram": "workspace:*",
         "@elizaos/client-twitter": "workspace:*",
+        "@elizaos/client-instagram": "workspace:*",
         "@elizaos/client-slack": "workspace:*",
         "@elizaos/core": "workspace:*",
         "@elizaos/plugin-0g": "workspace:*",

agent/src/index.ts

@@ -5,11 +5,12 @@ import { SqliteDatabaseAdapter } from "@elizaos/adapter-sqlite";
 import { SupabaseDatabaseAdapter } from "@elizaos/adapter-supabase";
 import { AutoClientInterface } from "@elizaos/client-auto";
 import { DiscordClientInterface } from "@elizaos/client-discord";
-import { FarcasterClientInterface } from "@elizaos/client-farcaster";
+import { InstagramClientInterface } from "@elizaos/client-instagram";
 import { LensAgentClient } from "@elizaos/client-lens";
 import { SlackClientInterface } from "@elizaos/client-slack";
 import { TelegramClientInterface } from "@elizaos/client-telegram";
 import { TwitterClientInterface } from "@elizaos/client-twitter";
+import { FarcasterClientInterface } from "@elizaos/client-farcaster";
 // import { ReclaimAdapter } from "@elizaos/plugin-reclaim";
 import { PrimusAdapter } from "@elizaos/plugin-primus";
 
@@ -29,10 +30,10 @@ import {
     IDatabaseAdapter,
     IDatabaseCacheAdapter,
     ModelProviderName,
+    parseBooleanFromText,
     settings,
     stringToUuid,
     validateCharacterConfig,
-    parseBooleanFromText,
 } from "@elizaos/core";
 import { zgPlugin } from "@elizaos/plugin-0g";
 
@@ -87,6 +88,7 @@ import { quaiPlugin } from "@elizaos/plugin-quai";
 import { sgxPlugin } from "@elizaos/plugin-sgx";
 import { solanaPlugin } from "@elizaos/plugin-solana";
 import { solanaAgentkitPlguin } from "@elizaos/plugin-solana-agentkit";
+import { squidRouterPlugin } from "@elizaos/plugin-squid-router";
 import { stargazePlugin } from "@elizaos/plugin-stargaze";
 import { storyPlugin } from "@elizaos/plugin-story";
 import { suiPlugin } from "@elizaos/plugin-sui";
@@ -96,7 +98,6 @@ import { teeMarlinPlugin } from "@elizaos/plugin-tee-marlin";
 import { verifiableLogPlugin } from "@elizaos/plugin-tee-verifiable-log";
 import { thirdwebPlugin } from "@elizaos/plugin-thirdweb";
 import { tonPlugin } from "@elizaos/plugin-ton";
-import { squidRouterPlugin } from "@elizaos/plugin-squid-router";
 import { webSearchPlugin } from "@elizaos/plugin-web-search";
 import { echoChambersPlugin } from "@elizaos/plugin-echochambers";
 import { dexScreenerPlugin } from "@elizaos/plugin-dexscreener";
@@ -612,6 +613,13 @@ export async function initializeClients(
         }
     }
 
+    if (clientTypes.includes(Clients.INSTAGRAM)) {
+        const instagramClient = await InstagramClientInterface.start(runtime);
+        if (instagramClient) {
+            clients.instagram = instagramClient;
+        }
+    }
+
     if (clientTypes.includes(Clients.FARCASTER)) {
         const farcasterClient = await FarcasterClientInterface.start(runtime);
         if (farcasterClient) {

client/src/lib/api.ts

@@ -1,6 +1,6 @@
 import { type UUID, type Character } from "@elizaos/core";
 
-const BASE_URL = "http://localhost:3000";
+const BASE_URL = `http://localhost:${import.meta.env.VITE_SERVER_PORT}`;
 
 const fetcher = async ({
     url,

client/vite.config.ts

@@ -1,6 +1,7 @@
 import { defineConfig } from "vite";
 import react from "@vitejs/plugin-react-swc";
 import viteCompression from "vite-plugin-compression";
+import path from "path";
 
 // https://vite.dev/config/
 export default defineConfig({
@@ -13,6 +14,7 @@ export default defineConfig({
         }),
     ],
     clearScreen: false,
+    envDir: path.resolve(__dirname, ".."),
     build: {
         outDir: "dist",
         minify: true,

docs/README_FR.md

@@ -8,7 +8,7 @@ _Utilisée dans [@DegenSpartanAI](https://x.com/degenspartanai) et [@MarcAIndree
 - Ajout de multiples personnages avec [characterfile](https://github.com/lalalune/characterfile/)
 - Support des fonctionnalités et connecteurs Discord/ Twitter / Telegram, avec salons vocaux sur Discord
 - Accès aux données en mémoire et aux documents stockés
-- Peut ouvrir et lire des documents PDF, retranscire des fichiers son et vidéo, résumer des conversations, etc.
+- Peut ouvrir et lire des documents PDF, retranscrire des fichiers son et vidéo, résumer des conversations, etc.
 - Supporte les modèles open source et locaux (configuré par défaut avec Nous Hermes Llama 3.1B)
 - Supporte OpenAI pour une utilisation sur le cloud depuis une machine peu performante
 - Mode "Ask Claude" pour l'utilisation de Claude sur des modèles complexes
@@ -22,10 +22,10 @@ _Utilisée dans [@DegenSpartanAI](https://x.com/degenspartanai) et [@MarcAIndree
 - [Node.js 22+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
 - [pnpm](https://pnpm.io/installation)
 
-### Edit the .env file
+### Éditer le fichier .env
 
-- Copy .env.example to .env and fill in the appropriate values
-- Edit the TWITTER environment variables to add your bot's username and password
+- Copiez le fichier .env.example, renommez-le en .env et remplissez les valeurs appropriées.
+- Modifiez les variables d'environnement TWITTER pour ajouter le nom d'utilisateur et le mot de passe de votre bot.
 
 ### Modifier les fichiers personnage
 
@@ -50,7 +50,7 @@ pnpm clean
 
 # Personnaliser Eliza
 
-### Ajouter un des actions personnalisées
+### Ajouter une des actions personnalisées
 
 Pour éviter les conflits Git dans le répertoire core, nous vous recommandons d’ajouter les actions personnalisées dans un répertoire `custom_actions` et de les configurer dans le fichier `elizaConfig.yaml` . Vous pouvez consulter l’exemple dans le fichier `elizaConfig.example.yaml`.
 
@@ -82,13 +82,13 @@ pnpm install --include=optional sharp
 Vous devez ajouter certaines variables à votre fichier .env pour vous connecter aux différentes plates-formes:
 
 ```
-# Variables d'environement Discord (nécessaires)
+# Variables d'environnement Discord (nécessaires)
 DISCORD_APPLICATION_ID=
 DISCORD_API_TOKEN= # Bot token
 OPENAI_API_KEY=sk-* # OpenAI API key, starting with sk-
 ELEVENLABS_XI_API_KEY= # API key from elevenlabs
 
-# Parmètres ELEVENLABS
+# Paramètres ELEVENLABS
 ELEVENLABS_MODEL_ID=eleven_multilingual_v2
 ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM
 ELEVENLABS_VOICE_STABILITY=0.5
@@ -144,7 +144,7 @@ Assurez-vous d’avoir le kit complet CUDA installé, y compris cuDNN et cuBLAS.
 ### Exécution locale
 
 Ajoutez XAI_MODEL et définissez-le à l’une des options ci-dessus [Run with
-Llama](#run-with-llama) - Vous pouvez laisser les valeurs X_SERVER_URL et XAI_API_KEY vides, le modèle est sera téléchargé depuis huggingface et sera modifié en local
+Llama](#run-with-llama) - Vous pouvez laisser les valeurs X_SERVER_URL et XAI_API_KEY vides, le modèle sera téléchargé depuis huggingface et sera modifié en local
 
 # Clients
 
@@ -173,7 +173,7 @@ pnpm test:sqljs    # Lance les tests avec SQL.js
 Les tests sont écrits en Jest et se trouvent ici : `src/**/*.test.ts`. L’environnement de test est configuré pour :
 
 - Charger les variables d’environnement depuis `.env.test`
-- Ajouter d'un délai d'attente de 2 minutes pour les tests de longue durée
+- Ajouter un délai d'attente de 2 minutes pour les tests de longue durée
 - Supporter les modules ESM
 - Lancer les tests de façon séquentielle (--runInBand)
 

packages/client-instagram/README.md

@@ -0,0 +1,113 @@
+# @elizaos/client-instagram
+
+An Instagram client implementation for ElizaOS, enabling Instagram integration with support for media posting, comment handling, and interaction management.
+
+## Features
+
+- Instagram API integration using instagram-private-api
+- Media post creation and scheduling
+- Comment and interaction handling
+- Profile management
+- Media processing utilities
+- Rate limiting and request queuing
+- Session management and caching
+
+## Installation
+
+As this is a workspace package, it's installed as part of the ElizaOS monorepo:
+
+```bash
+pnpm install
+```
+
+## Configuration
+
+The client requires the following environment variables:
+
+```bash
+# Instagram Credentials
+INSTAGRAM_USERNAME=your_username
+INSTAGRAM_PASSWORD=your_password
+INSTAGRAM_APP_ID=your_app_id
+INSTAGRAM_APP_SECRET=your_app_secret
+
+# Optional Business Account
+INSTAGRAM_BUSINESS_ACCOUNT_ID=your_business_account_id
+
+# Posting Configuration
+POST_INTERVAL_MIN=90        # Minimum interval between posts (minutes)
+POST_INTERVAL_MAX=180       # Maximum interval between posts (minutes)
+ENABLE_ACTION_PROCESSING=true
+ACTION_INTERVAL=5           # Minutes between action processing
+MAX_ACTIONS_PROCESSING=1    # Maximum actions to process per interval
+```
+
+## Usage
+
+### Basic Initialization
+
+```typescript
+import { InstagramClientInterface } from '@elizaos/client-instagram';
+
+// Initialize the client
+const instagramManager = await InstagramClientInterface.start(runtime);
+```
+
+### Posting Content
+
+All posts on Instagram must include media (image, video, or carousel):
+
+```typescript
+// Post a single image
+await instagramManager.post.createPost({
+  media: [{
+    type: 'IMAGE',
+    url: 'path/to/image.jpg'
+  }],
+  caption: 'Hello Instagram!'
+});
+
+// Post a carousel
+await instagramManager.post.createPost({
+  media: [
+    { type: 'IMAGE', url: 'path/to/image1.jpg' },
+    { type: 'IMAGE', url: 'path/to/image2.jpg' }
+  ],
+  caption: 'Check out these photos!'
+});
+```
+
+### Handling Interactions
+
+```typescript
+// Handle comments
+await instagramManager.interaction.handleComment({
+  mediaId: 'media-123',
+  comment: 'Great post!',
+  userId: 'user-123'
+});
+
+// Like media
+await instagramManager.interaction.likeMedia('media-123');
+```
+
+## Key Components
+
+1. ClientBase
+    - Handles authentication and session management
+    - Manages API rate limiting
+    - Provides core API functionality
+
+
+2. PostClient
+    - Manages media uploads
+    - Handles post scheduling
+    - Processes media before upload
+
+
+3. InteractionClient
+    - Handles comments and likes
+    - Manages user interactions
+    - Processes notifications
+
+

packages/client-instagram/package.json

@@ -0,0 +1,37 @@
+{
+    "name": "@elizaos/client-instagram",
+    "version": "0.1.0",
+    "type": "module",
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "exports": {
+        "./package.json": "./package.json",
+        ".": {
+            "import": {
+                "@elizaos/source": "./src/index.ts",
+                "types": "./dist/index.d.ts",
+                "default": "./dist/index.js"
+            }
+        }
+    },
+    "files": [
+        "dist"
+    ],
+    "dependencies": {
+        "@elizaos/core": "workspace:*",
+        "zod": "3.23.8",
+        "instagram-private-api": "^1.45.3",
+        "sharp": "^0.33.2",
+        "glob": "11.0.0"
+    },
+    "devDependencies": {
+        "tsup": "8.3.5",
+        "@types/sharp": "^0.32.0"
+    },
+    "scripts": {
+        "build": "tsup --format esm --dts",
+        "dev": "tsup --format esm --dts --watch",
+        "lint": "eslint --fix --cache ."
+    }
+}