nyxora 1.0.6 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -21
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -26,36 +26,56 @@ With a beautiful, real-time dashboard inspired by modern control centers, Nyxora
|
|
|
26
26
|
### 📱 Telegram Integration
|
|
27
27
|
* Take your agent anywhere! Connect Nyxora to a Telegram Bot to execute trades, check prices, and chat on the go.
|
|
28
28
|
|
|
29
|
-
## Quick Start 🚀
|
|
29
|
+
## Quick Start 🚀 (Global Install)
|
|
30
30
|
|
|
31
|
-
|
|
32
|
-
Clone the repository and install dependencies for both the backend and the dashboard:
|
|
31
|
+
Nyxora is now available on NPM! You can install it as a global CLI tool on your operating system.
|
|
33
32
|
|
|
33
|
+
### 1. Installation
|
|
34
|
+
Open your terminal (Command Prompt, PowerShell, or Linux Terminal) and run:
|
|
34
35
|
```bash
|
|
35
|
-
|
|
36
|
-
cd Nyxora
|
|
37
|
-
npm install
|
|
38
|
-
cd dashboard && npm install && cd ..
|
|
36
|
+
npm install -g nyxora
|
|
39
37
|
```
|
|
40
38
|
|
|
41
|
-
### 2.
|
|
42
|
-
|
|
39
|
+
### 2. Launching Nyxora
|
|
40
|
+
No need to navigate to any specific folder! Just type:
|
|
43
41
|
```bash
|
|
44
|
-
|
|
42
|
+
nyxora
|
|
45
43
|
```
|
|
46
|
-
|
|
44
|
+
Nyxora will automatically:
|
|
45
|
+
1. Initialize a secure vault in your `~/.nyxora/` directory (where your `.env` and `memory.json` will safely live).
|
|
46
|
+
2. Start the local server.
|
|
47
|
+
3. Open the gorgeous Web Dashboard automatically in your default browser!
|
|
47
48
|
|
|
48
|
-
### 3.
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
49
|
+
### 3. Configuration
|
|
50
|
+
When the dashboard opens, simply enter your **OpenAI/Gemini API Key** and your **Wallet Private Key** in the Settings tab. These are securely saved in your local OS environment (`~/.nyxora/.env`) and never exposed to the internet.
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Local Development (For Contributors) 🏗️
|
|
55
|
+
|
|
56
|
+
If you want to modify Nyxora's code, build new skills, or contribute:
|
|
57
|
+
|
|
58
|
+
1. Clone the repo:
|
|
59
|
+
```bash
|
|
60
|
+
git clone https://github.com/perasyudha/Nyxora.git
|
|
61
|
+
cd Nyxora
|
|
62
|
+
```
|
|
63
|
+
2. Install dependencies:
|
|
64
|
+
```bash
|
|
65
|
+
npm install
|
|
66
|
+
cd dashboard && npm install && cd ..
|
|
67
|
+
```
|
|
68
|
+
3. Run the development build:
|
|
69
|
+
```bash
|
|
70
|
+
npm run build && npm run start
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
*To deploy your own branch to NPM, bump the version and run `npm run deploy`!*
|
|
54
74
|
|
|
55
|
-
## Architecture
|
|
56
|
-
* **Backend**: Node.js, Express, Viem (Web3), node-telegram-bot-api, OpenAI API
|
|
57
|
-
* **Frontend**: React, Vite,
|
|
58
|
-
* **Data**: Local
|
|
75
|
+
## Architecture
|
|
76
|
+
* **Backend**: Node.js, Express, Viem (Web3), node-telegram-bot-api, OpenAI API.
|
|
77
|
+
* **Frontend**: React, Vite, Vanilla CSS, Web Speech API (TTS/STT).
|
|
78
|
+
* **Data**: Local `~/.nyxora/config.yaml` and `~/.nyxora/memory.json`.
|
|
59
79
|
|
|
60
80
|
## License
|
|
61
81
|
MIT License
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "nyxora",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.7",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "dist/gateway/cli.js",
|
|
6
6
|
"files": [
|
|
@@ -19,7 +19,8 @@
|
|
|
19
19
|
"build": "npm run build --prefix dashboard && tsc",
|
|
20
20
|
"start": "node dist/gateway/cli.js",
|
|
21
21
|
"dashboard": "npm run build && node dist/gateway/cli.js",
|
|
22
|
-
"test": "echo \"Error: no test specified\" && exit 1"
|
|
22
|
+
"test": "echo \"Error: no test specified\" && exit 1",
|
|
23
|
+
"deploy": "npm run build && git add . && git commit -m \"chore: auto-deploy new feature\" && git push && npm publish"
|
|
23
24
|
},
|
|
24
25
|
"keywords": [],
|
|
25
26
|
"author": "",
|