nyxora 1.0.6 → 1.0.8

package/README.md

@@ -7,7 +7,7 @@ With a beautiful, real-time dashboard inspired by modern control centers, Nyxora
 ## Features ✨
 
 ### 🧠 Core Agent Capabilities
-*   **Multi-LLM Support**: Seamlessly switch between Google Gemini, OpenAI, or local Ollama models dynamically.
+*   **Multi-LLM Support**: Seamlessly switch between Google Gemini, OpenAI, OpenRouter (unlimited models!), or local Ollama models dynamically.
 *   **Round-Robin API Rotation**: Add up to 10 API keys via the dashboard. The system will auto-rotate them to prevent rate-limiting and token drain.
 *   **Deep Personalization**: Feed the agent custom rules via `user.md` and define its core persona via `IDENTITY.md`.
 *   **Multi-Lingual Auto-Sync**: The agent natively detects your language and replies in the exact same language automatically.
@@ -26,36 +26,59 @@ With a beautiful, real-time dashboard inspired by modern control centers, Nyxora
 ### 📱 Telegram Integration
 *   Take your agent anywhere! Connect Nyxora to a Telegram Bot to execute trades, check prices, and chat on the go.
 
-## Quick Start 🚀
+## Quick Start 🚀 (Global Install)
 
-### 1. Installation
-Clone the repository and install dependencies for both the backend and the dashboard:
+Nyxora is now available on NPM! You can install it as a global CLI tool on your operating system.
 
+### 1. Installation
+Open your terminal (Command Prompt, PowerShell, or Linux Terminal) and run:
 ```bash
-git clone https://github.com/perasyudha/Nyxora.git
-cd Nyxora
-npm install
-cd dashboard && npm install && cd ..
+npm install -g nyxora
 ```
 
-### 2. Configuration
-Copy the `.env.example` file to `.env` and fill in your private keys.
+### 2. Launching Nyxora
+No need to navigate to any specific folder! Just type:
 ```bash
-cp .env.example .env
+nyxora
 ```
-> **⚠️ WARNING**: NEVER commit your `.env` file! It contains your wallet's private key, API keys, and Telegram Bot Token.
+On first launch, Nyxora will greet you with an **Interactive Setup Wizard**. This CLI wizard will guide you to securely configure your LLM providers, API keys, and Web3 Wallet.
 
-### 3. Run the Dashboard & Bot
-Nyxora runs a unified backend API, a Telegram Bot listener, and a Vite React frontend concurrently.
-```bash
-npm run build && npm run dashboard
-```
-This will automatically launch the UI in your default web browser at `http://localhost:5173`.
+Nyxora will automatically:
+1. Initialize a secure vault in your `~/.nyxora/` directory.
+2. Store your Wallet Private Key securely in `~/.nyxora/.env`.
+3. Store operational data (API Keys, RPCs) in `~/.nyxora/config.yaml`.
+4. Start the local server and open the Web Dashboard automatically!
+
+> 💡 **Tip:** You can invoke the setup wizard at any time to update your keys by running `nyxora setup`.
+
+### 3. Configuration
+When the dashboard opens, you can modify any operational parameters in the **Settings** tab. The dashboard allows you to type custom model names, switch RPCs, and rotate your API keys effortlessly.
+
+## Local Development (For Contributors) 🏗️
+
+If you want to modify Nyxora's code, build new skills, or contribute:
+
+1. Clone the repo:
+   ```bash
+   git clone https://github.com/perasyudha/Nyxora.git
+   cd Nyxora
+   ```
+2. Install dependencies:
+   ```bash
+   npm install
+   cd dashboard && npm install && cd ..
+   ```
+3. Run the development build:
+   ```bash
+   npm run build && npm run start
+   ```
+
+*To deploy your own branch to NPM, bump the version and run `npm run deploy`!*
 
-## Architecture 🏗️
-*   **Backend**: Node.js, Express, Viem (Web3), node-telegram-bot-api, OpenAI API (compatible with Gemini & Ollama).
-*   **Frontend**: React, Vite, Tailwind/Vanilla CSS, Web Speech API (TTS/STT).
-*   **Data**: Local `config.yaml` for settings and `memory.json` for persistent agent conversations.
+## Architecture
+*   **Backend**: Node.js, Express, Viem (Web3), node-telegram-bot-api, OpenAI API.
+*   **Frontend**: React, Vite, Vanilla CSS, Web Speech API (TTS/STT).
+*   **Data**: Local `~/.nyxora/config.yaml` and `~/.nyxora/memory.json`.
 
 ## License
 MIT License

package/config.yaml

@@ -5,6 +5,10 @@ llm:
   provider: gemini
   model: gemini-2.5-flash
   temperature: 0.2
+  credentials: {}
 memory:
   type: file
   path: ./memory.json
+integrations:
+  telegram:
+    enabled: false