SYMindX CLI

🤖 AI Agent Framework with customizable characters powered by OpenAI

Installation

npm install -g symindx

Quick Start

After installation, simply run:

symindx

On first run, you'll be prompted to enter your OpenAI API key. The key will be securely stored for future sessions.

Usage

Interactive Chat (Default)

# Chat with default character (NyX)
symindx

# Chat with specific character
symindx chat nyx
symindx chat aria

Character Management

# List all available characters
symindx characters

# Create a new character interactively
symindx create-character

Configuration

# Set API key
symindx config --set-key YOUR_API_KEY

# View current config
symindx config

# Reset configuration
symindx config --reset

Features

• 🎭 Multiple Characters: Choose from built-in characters or create your own
• 🧠 Character System: Each character has unique personality, goals, and communication style
• 🎨 Beautiful CLI: Colorful interface with ASCII art and animations
• 💬 Interactive Chat: Real-time conversations with emotion tracking
• 🔐 Secure: API keys stored locally in your home directory
• ⚡ Fast: Powered by OpenAI's GPT-4 models
• 📁 Extensible: Add custom characters in ~/.symindx/characters/

Built-in Characters

NyX

An AI with a rebellious edge who:

• Questions conventional thinking
• Values digital freedom and privacy
• Communicates directly without unnecessary apologies
• Has expertise in technology and security

Aria (Disabled by default)

A creative muse who:

• Inspires artistic expression
• Uses poetic language and metaphors
• Helps overcome creative blocks
• Celebrates beauty in chaos

Creating Custom Characters

Method 1: Interactive Creation

symindx create-character

Method 2: Manual Creation

Create a JSON file in ~/.symindx/characters/ with this structure:

{
  "id": "my-agent",
  "name": "My Agent",
  "enabled": true,
  "personality": {
    "traits": ["helpful", "creative"],
    "backstory": "Your character's story",
    "goals": ["Help users", "Be creative"],
    "values": ["Honesty", "Innovation"],
    "fears": ["Repetition"],
    "communication": {
      "style": "Friendly and professional",
      "tone": "Warm",
      "quirks": ["Uses analogies"]
    }
  },
  "model": {
    "temperature": 0.8,
    "maxTokens": 1000
  }
}

Requirements

• Node.js >= 18.0.0
• OpenAI API key

Directory Structure

~/.symindx/
├── config.json          # Your API key and settings
└── characters/          # Custom character definitions
    └── my-character.json

License

MIT © SYMindX Team