@aman_asmuei/aman-agent 0.42.0 → 0.43.0

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 CHANGED
@@ -343,6 +343,8 @@ npx @aman_asmuei/aman-agent
343
343
 
344
344
  ---
345
345
 
346
+ > **New to the ecosystem?** See [docs/ecosystem.md](docs/ecosystem.md) for "which package do I install, and when" + the full package relationship diagram.
347
+
346
348
  ## Architecture at a Glance
347
349
 
348
350
  aman-agent is the **runtime** at the center of the aman ecosystem — 78 TypeScript modules that stitch together memory, identity, orchestration, and any LLM into one coherent system.
@@ -443,6 +445,50 @@ flowchart TB
443
445
 
444
446
  ---
445
447
 
448
+ ## Install tiers — pick what you need
449
+
450
+ The aman ecosystem is ~10 packages. You don't need them all. Pick a tier:
451
+
452
+ ### Minimal (2 packages, 2 minutes)
453
+
454
+ Just `aman-agent` + persistent memory. Standalone CLI, works with any LLM provider. Best for "does this feel useful?" evaluation.
455
+
456
+ ```bash
457
+ npm install -g @aman_asmuei/aman-agent @aman_asmuei/amem-core
458
+ # or, once you have Node 18+:
459
+ curl -fsSL https://raw.githubusercontent.com/amanasmuei/aman-agent/main/bin/aman-setup.sh | bash
460
+ ```
461
+
462
+ What you get: `aman-agent` CLI, per-message memory recall, memory extraction, `/memory` commands.
463
+
464
+ ### Productive (5 packages, 10 minutes)
465
+
466
+ Minimal + identity + guardrails + Claude Code integration. Adds your AI's personality, rules the LLM must respect, and first-class Claude Code plugin support.
467
+
468
+ ```bash
469
+ npm install -g @aman_asmuei/aman-agent @aman_asmuei/amem-core \
470
+ @aman_asmuei/acore-core @aman_asmuei/arules-core @aman_asmuei/aman-mcp
471
+ # + install the Claude Code plugin:
472
+ # see aman-claude-code repo README
473
+ ```
474
+
475
+ What you get (on top of Minimal): named companion ("Aman" by default), rule enforcement via `/rules`, auto-loaded ecosystem context at session start, MCP tools for memory/identity/rules from inside Claude Code.
476
+
477
+ ### Complete (all packages, 30 minutes)
478
+
479
+ Everything: orchestration, multi-agent delegation, showcase personalities, tool installer, skill manager, VS Code Copilot integration.
480
+
481
+ ```bash
482
+ # After Productive, add:
483
+ npm install -g @aman_asmuei/aman-copilot @aman_asmuei/akit @aman_asmuei/askill @aman_asmuei/aman-showcase
484
+ ```
485
+
486
+ What you get (on top of Productive): `/orchestrate` DAG task decomposition, `/delegate` + `/team` multi-agent workflows, `/showcase` 13 personality templates, `/akit` CLI tool manager, `/askill` skill library. VS Code Copilot users also get `aman-copilot` for inline Copilot Chat memory.
487
+
488
+ **Not sure which tier?** Start with Minimal. You can layer Productive or Complete on top whenever you want — nothing gets overwritten, just extended.
489
+
490
+ ---
491
+
446
492
  ## Quick Start
447
493
 
448
494
  ### Claude Code plugin (recommended)
@@ -701,6 +747,27 @@ You > Let's add a new endpoint
701
747
  /decisions View your decision log
702
748
  ```
703
749
 
750
+ ### Memory mirror (markdown)
751
+
752
+ Your memory DB is great for the agent, but sometimes you want memories as **plain Markdown files** you can `grep`, edit in any editor, commit to git, or sync with Dropbox/iCloud across devices. The mirror gives you exactly that — a human-readable copy of every memory that round-trips cleanly back into the DB.
753
+
754
+ ```
755
+ /memory export --to <dir> One-shot snapshot of all memories as .md files
756
+ /memory mirror status Show live mirror path, file count, last sync
757
+ /memory mirror rebuild Re-materialise the mirror from the DB
758
+ /memory sync --from <dir> Reconstitute the DB from a directory of .md files
759
+ ```
760
+
761
+ **When you want this:**
762
+
763
+ - **Human-readable backup** — `grep -r "postgres" ~/.aman-agent/memories/` to see every memory that mentions Postgres.
764
+ - **Edit outside the agent** — fix a typo or retire a stale decision in your favourite editor, then run `/memory sync --from ...` (or just restart — startup auto-syncs).
765
+ - **Version-control your memory** — `git init ~/.aman-agent/memories/` and you get a full history of every memory the agent has ever learned.
766
+ - **Multi-device sync** — point the mirror dir at a synced folder (Dropbox, iCloud, Syncthing) and your memories follow you.
767
+ - **No lock-in** — YAML-frontmatter Markdown is readable without aman-agent ever being installed again.
768
+
769
+ Opt-out: `config.mirror.enabled = false` disables all mirror I/O. Disable auto-sync on startup only with `config.mirror.autoSyncOnStartup = false`.
770
+
704
771
  </details>
705
772
 
706
773
  <details>
@@ -0,0 +1,36 @@
1
+ #!/usr/bin/env bash
2
+ # aman-setup: non-interactive Minimal install.
3
+ # Installs aman-agent + amem-core globally via npm. Requires Node 18+.
4
+ #
5
+ # Advanced tiers (Productive, Complete) require more choices — see
6
+ # the README for the relevant package lists.
7
+
8
+ set -euo pipefail
9
+
10
+ echo "=== aman Minimal install ==="
11
+ echo "Installs: aman-agent + amem-core"
12
+ echo ""
13
+
14
+ if ! command -v node >/dev/null 2>&1; then
15
+ echo "ERROR: node not found. Install Node 18+ first: https://nodejs.org" >&2
16
+ exit 1
17
+ fi
18
+
19
+ NODE_VERSION_MAJOR=$(node -p "process.versions.node.split('.')[0]")
20
+ if [ "$NODE_VERSION_MAJOR" -lt 18 ]; then
21
+ echo "ERROR: Node 18+ required (you have $(node --version))" >&2
22
+ exit 1
23
+ fi
24
+
25
+ if ! command -v npm >/dev/null 2>&1; then
26
+ echo "ERROR: npm not found. Reinstall Node from https://nodejs.org" >&2
27
+ exit 1
28
+ fi
29
+
30
+ echo "Installing @aman_asmuei/aman-agent + @aman_asmuei/amem-core..."
31
+ npm install -g @aman_asmuei/aman-agent @aman_asmuei/amem-core
32
+
33
+ echo ""
34
+ echo "=== Done ==="
35
+ echo "Run: aman-agent"
36
+ echo "See the README's 'Install tiers' section for Productive / Complete upgrades."