@agenticmail/enterprise 0.5.313 → 0.5.314
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 +70 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,6 +12,76 @@ One command. Interactive setup wizard. Full platform in under 2 minutes.
|
|
|
12
12
|
|
|
13
13
|
---
|
|
14
14
|
|
|
15
|
+
## Getting Started (5 Minutes)
|
|
16
|
+
|
|
17
|
+
### What You Need
|
|
18
|
+
|
|
19
|
+
| Requirement | Details |
|
|
20
|
+
|------------|---------|
|
|
21
|
+
| **Node.js** | v18 or higher ([download](https://nodejs.org)) |
|
|
22
|
+
| **Database** | SQLite (built-in, zero config) or Postgres (recommended for production) |
|
|
23
|
+
| **LLM API Key** | At least one: [Anthropic](https://console.anthropic.com), [OpenAI](https://platform.openai.com), or [xAI](https://console.x.ai) |
|
|
24
|
+
|
|
25
|
+
### Step 1: Run the Setup Wizard
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npx @agenticmail/enterprise
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
This launches an interactive wizard that walks you through everything. No config files to edit manually.
|
|
32
|
+
|
|
33
|
+
### Step 2: Choose Your Database
|
|
34
|
+
|
|
35
|
+
**Option A: SQLite (Easiest — great for trying it out)**
|
|
36
|
+
- Select "SQLite" in the wizard
|
|
37
|
+
- Data stored locally in a file — zero configuration
|
|
38
|
+
- Perfect for development, demos, and small deployments
|
|
39
|
+
|
|
40
|
+
**Option B: Free Supabase Postgres (Recommended for production)**
|
|
41
|
+
1. Go to [supabase.com](https://supabase.com) and create a free account
|
|
42
|
+
2. Create a new project (free tier gives you a full Postgres database)
|
|
43
|
+
3. Go to **Settings → Database → Connection string → URI**
|
|
44
|
+
4. Select **"Transaction mode"** (port 6543) — this is important!
|
|
45
|
+
5. Copy the connection string and paste it in the wizard
|
|
46
|
+
|
|
47
|
+
> **The wizard auto-optimizes your connection string** — it detects Supabase URLs, switches to the right pooler mode, adds the correct parameters, and generates a direct URL for migrations. You don't need to configure anything manually.
|
|
48
|
+
|
|
49
|
+
**Option C: Any Postgres, MySQL, MongoDB, or other database**
|
|
50
|
+
- We support 10 database backends — see [Database Backends](#database-backends)
|
|
51
|
+
- Just paste your connection string and the wizard handles the rest
|
|
52
|
+
|
|
53
|
+
### Step 3: Create Your Admin Account
|
|
54
|
+
|
|
55
|
+
- Enter your name, email, and password
|
|
56
|
+
- This becomes the owner account with full access
|
|
57
|
+
|
|
58
|
+
### Step 4: Open the Dashboard
|
|
59
|
+
|
|
60
|
+
The wizard gives you a URL (default: `http://localhost:3000`). Open it and you'll see:
|
|
61
|
+
- **Setup Checklist** — guided steps to configure email, create agents, etc.
|
|
62
|
+
- **Create Agent** — pick from 51 personality templates or build your own
|
|
63
|
+
- **Full Admin Dashboard** — 28 pages covering every aspect of agent management
|
|
64
|
+
|
|
65
|
+
### Step 5: Create Your First Agent
|
|
66
|
+
|
|
67
|
+
1. Click **"Create Agent"** in the dashboard
|
|
68
|
+
2. Choose a soul template (e.g., "Executive Assistant", "Sales Rep", "Developer")
|
|
69
|
+
3. Add your LLM API key in **Settings → API Keys** (or in the agent's config)
|
|
70
|
+
4. Start the agent — it'll get its own email, tools, and identity
|
|
71
|
+
|
|
72
|
+
### What's Next?
|
|
73
|
+
|
|
74
|
+
- **Connect Gmail** — Give your agent real email access via OAuth (Agent Detail → Email tab)
|
|
75
|
+
- **Add Telegram/WhatsApp** — Connect messaging channels (Agent Detail → Channels tab)
|
|
76
|
+
- **Set up DLP** — Apply pre-built rule packs to protect sensitive data (DLP page → Rule Packs)
|
|
77
|
+
- **Configure Shifts** — Set work hours and on-call schedules (Workforce page)
|
|
78
|
+
- **Run Standalone** — For production, run each agent as its own process:
|
|
79
|
+
```bash
|
|
80
|
+
node dist/cli.js agent --env-file=.env.my-agent
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
15
85
|
## Table of Contents
|
|
16
86
|
|
|
17
87
|
- [Why AgenticMail Enterprise](#why-agenticmail-enterprise)
|