@aman_asmuei/aman 0.3.0 → 0.3.1
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 +78 -12
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
|
|
10
10
|
### Your complete AI companion.
|
|
11
11
|
|
|
12
|
-
Identity + Memory + Tools + Workflows + Guardrails + Evaluation —
|
|
12
|
+
Identity + Memory + Tools + Workflows + Guardrails + Skills + Evaluation — setup, deploy, run anywhere.
|
|
13
13
|
|
|
14
14
|
<br>
|
|
15
15
|
|
|
@@ -47,23 +47,29 @@ Sets up your complete AI ecosystem:
|
|
|
47
47
|
|
|
48
48
|
```
|
|
49
49
|
aman
|
|
50
|
-
├── acore
|
|
51
|
-
├── amem
|
|
52
|
-
├── akit
|
|
53
|
-
├── aflow
|
|
54
|
-
├── arules
|
|
55
|
-
|
|
50
|
+
├── acore → identity → who your AI IS
|
|
51
|
+
├── amem → memory → what your AI KNOWS
|
|
52
|
+
├── akit → tools → what your AI CAN DO
|
|
53
|
+
├── aflow → workflows → HOW your AI works
|
|
54
|
+
├── arules → guardrails → what your AI WON'T do
|
|
55
|
+
├── askill → skills → what your AI MASTERS
|
|
56
|
+
├── aeval → evaluation → how GOOD your AI is
|
|
57
|
+
├── achannel → channels → WHERE your AI lives
|
|
58
|
+
└── aman-agent → runtime → the engine that runs it all
|
|
56
59
|
```
|
|
57
60
|
|
|
58
61
|
| Layer | Package | What it does |
|
|
59
62
|
|:------|:--------|:-------------|
|
|
60
|
-
| Identity | [acore](https://github.com/amanasmuei/acore) | Personality, values, relationship memory |
|
|
61
|
-
| Memory | [amem](https://github.com/amanasmuei/amem) | Automated knowledge storage (MCP) |
|
|
63
|
+
| Identity | [acore](https://github.com/amanasmuei/acore) | Personality, values, appearance, relationship memory |
|
|
64
|
+
| Memory | [amem](https://github.com/amanasmuei/amem) | Automated knowledge storage with semantic search (MCP) |
|
|
62
65
|
| Tools | [akit](https://github.com/amanasmuei/akit) | 15 portable AI tools (MCP + manual fallback) |
|
|
63
66
|
| Workflows | [aflow](https://github.com/amanasmuei/aflow) | Reusable AI workflows (code review, bug fix, etc.) |
|
|
64
67
|
| Guardrails | [arules](https://github.com/amanasmuei/arules) | Safety boundaries and permissions |
|
|
68
|
+
| Skills | [askill](https://github.com/amanasmuei/askill) | Domain expertise with leveling (testing, security, etc.) |
|
|
65
69
|
| Evaluation | [aeval](https://github.com/amanasmuei/aeval) | Relationship tracking and session logging |
|
|
66
|
-
|
|
|
70
|
+
| Channels | [achannel](https://github.com/amanasmuei/achannel) | Telegram, Discord, webhook server |
|
|
71
|
+
| Runtime | [aman-agent](https://github.com/amanasmuei/aman-agent) | Standalone AI companion CLI |
|
|
72
|
+
| **Unified** | **[aman](https://github.com/amanasmuei/aman)** | **Setup + Deploy — one command for everything** |
|
|
67
73
|
|
|
68
74
|
Each package works independently. `aman` is the front door.
|
|
69
75
|
|
|
@@ -75,7 +81,8 @@ Each package works independently. `aman` is the front door.
|
|
|
75
81
|
|:--------|:------------|
|
|
76
82
|
| `aman` | First run: setup. After that: show status |
|
|
77
83
|
| `aman setup` | Set up the full ecosystem |
|
|
78
|
-
| `aman status` | View ecosystem status (all
|
|
84
|
+
| `aman status` | View ecosystem status (all layers) |
|
|
85
|
+
| `aman deploy` | Deploy your AI anywhere (Docker, Ollama, systemd) |
|
|
79
86
|
|
|
80
87
|
After setup, use the individual CLIs for detailed management:
|
|
81
88
|
|
|
@@ -114,6 +121,65 @@ $ aman status
|
|
|
114
121
|
|
|
115
122
|
---
|
|
116
123
|
|
|
124
|
+
## Deploy Anywhere
|
|
125
|
+
|
|
126
|
+
Make your AI companion always-on — accessible from terminal, browser, Telegram, or Discord.
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
npx @aman_asmuei/aman deploy
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Interactive wizard with 4 deployment methods:
|
|
133
|
+
|
|
134
|
+
### Docker Compose (VPS / Home Server)
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
aman deploy # select "Docker Compose", enter API key
|
|
138
|
+
docker compose up -d # → running on port 3000
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Packages the full ecosystem in one container: aman-agent + achannel (Telegram/Discord/webhook) + aman-mcp + amem.
|
|
142
|
+
|
|
143
|
+
### Docker + Ollama (Fully Local)
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
aman deploy # select "Docker + Ollama"
|
|
147
|
+
docker compose up -d # → aman + Ollama, zero cloud dependency
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
No API key needed. Runs on Raspberry Pi 4/5 (ARM64), any Linux, macOS.
|
|
151
|
+
|
|
152
|
+
### Systemd Service (Bare Metal / Raspberry Pi)
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
aman deploy # select "Systemd service"
|
|
156
|
+
# Shows step-by-step install for bare metal Linux
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
### What's in the Docker Image
|
|
160
|
+
|
|
161
|
+
| Component | What it does |
|
|
162
|
+
|:---|:---|
|
|
163
|
+
| **aman-agent** | Interactive CLI companion |
|
|
164
|
+
| **achannel** | Telegram, Discord, webhook server |
|
|
165
|
+
| **aman-mcp** | MCP bridge for all ecosystem layers |
|
|
166
|
+
| **amem** | Persistent memory with SQLite |
|
|
167
|
+
|
|
168
|
+
### Environment Variables
|
|
169
|
+
|
|
170
|
+
| Variable | Description |
|
|
171
|
+
|:---|:---|
|
|
172
|
+
| `ANTHROPIC_API_KEY` | Anthropic API key |
|
|
173
|
+
| `OPENAI_API_KEY` | OpenAI API key (alternative) |
|
|
174
|
+
| `AMAN_AI_NAME` | Your AI's name (default: Aman) |
|
|
175
|
+
| `AMAN_MODEL` | LLM model (default: claude-sonnet-4-6) |
|
|
176
|
+
| `TELEGRAM_BOT_TOKEN` | Optional — Telegram bot |
|
|
177
|
+
| `DISCORD_BOT_TOKEN` | Optional — Discord bot |
|
|
178
|
+
|
|
179
|
+
All data persists in Docker volumes (identity, memory, config, rules, workflows, skills, eval).
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
117
183
|
## How It All Connects
|
|
118
184
|
|
|
119
185
|
Every layer is a markdown file. acore auto-injects all of them into your AI's system prompt:
|
|
@@ -151,6 +217,6 @@ ChatGPT, Claude, Claude Code, Cursor, Windsurf, Gemini, Ollama, and any AI that
|
|
|
151
217
|
|
|
152
218
|
<div align="center">
|
|
153
219
|
|
|
154
|
-
**
|
|
220
|
+
**Setup. Deploy. Run anywhere. Your AI companion.**
|
|
155
221
|
|
|
156
222
|
</div>
|
package/dist/index.js
CHANGED
|
@@ -838,7 +838,7 @@ function copyDeployFile(pkgDir, destDir, filename) {
|
|
|
838
838
|
|
|
839
839
|
// src/index.ts
|
|
840
840
|
var program = new Command();
|
|
841
|
-
program.name("aman").description("Your complete AI companion \u2014 identity, memory, and tools in one command").version("0.3.
|
|
841
|
+
program.name("aman").description("Your complete AI companion \u2014 identity, memory, and tools in one command").version("0.3.1").action(() => {
|
|
842
842
|
const ecosystem = detectEcosystem();
|
|
843
843
|
if (ecosystem.acore.installed) {
|
|
844
844
|
statusCommand();
|