Skip to content

Commit 79c1ce5

Browse files
committed
docs: clarify that mautic-cli runs locally, improve Quick Start
Add "How it works" section explaining the local-to-remote architecture with an ASCII diagram. Expand Quick Start with uv install step and note that no Python knowledge is needed. Move pip install to collapsible alternative section.
1 parent 493a7e2 commit 79c1ce5

1 file changed

Lines changed: 34 additions & 3 deletions

File tree

README.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,21 @@
1616

1717
---
1818

19+
## How it works
20+
21+
Mautic-CLI runs on **your local machine** (laptop, desktop, CI server) and connects to your Mautic instance remotely via its REST API. You don't install anything on your Mautic server - you just need to enable the API there.
22+
23+
```
24+
┌──────────────────┐ HTTPS ┌──────────────────┐
25+
│ Your computer │ ────── API calls ─────▶│ Mautic server │
26+
│ (mautic-cli) │ ◀──── JSON responses ──│ (any hosting) │
27+
└──────────────────┘ └──────────────────┘
28+
```
29+
30+
**On your Mautic server:** Go to Settings > API Settings, enable the API, and enable Basic Authentication (or set up OAuth2 credentials).
31+
32+
**On your machine:** Install the CLI and run `mautic auth setup` - see Quick Start below.
33+
1934
## What it does
2035

2136
| Category | Capabilities |
@@ -41,19 +56,35 @@
4156

4257
## Quick Start
4358

59+
No Python knowledge needed. The recommended installer, [uv](https://docs.astral.sh/uv/), handles everything including Python itself:
60+
4461
```bash
45-
# 1. Install (or upgrade)
46-
uv tool install mautic-cli # or: pip install mautic-cli
62+
# 0. Install uv (one-time) — see https://docs.astral.sh/uv/getting-started/installation/
63+
curl -LsSf https://astral.sh/uv/install.sh | sh # macOS / Linux
64+
# powershell -c "irm https://astral.sh/uv/install.ps1 | iex" # Windows
65+
66+
# 1. Install mautic-cli (uv downloads the right Python automatically)
67+
uv tool install mautic-cli
4768
uv tool install --upgrade mautic-cli # upgrade to latest
4869

49-
# 2. Authenticate
70+
# 2. Authenticate (connects to your remote Mautic instance)
5071
mautic auth setup
5172

5273
# 3. Use it
5374
mautic contacts list --limit 5
5475
mautic --format table emails list
5576
```
5677

78+
<details>
79+
<summary><strong>Alternative: install with pip</strong></summary>
80+
81+
If you already have Python 3.11+ installed and prefer pip:
82+
83+
```bash
84+
pip install mautic-cli
85+
```
86+
</details>
87+
5788
🤖 **Using an AI agent?** Add the [skill](skills/mautic/SKILL.md) and let your agent handle the rest:
5889

5990
```bash

0 commit comments

Comments
 (0)