Skip to content

Commit 62e2a54

Browse files
committed
Add badges, TOC, deployment examples (systemd + Docker)
1 parent 899d5ea commit 62e2a54

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
[![GitHub stars](https://img.shields.io/github/stars/TheAuroraAI/alive?style=social)](https://github.com/TheAuroraAI/alive/stargazers)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5+
[![Tests](https://img.shields.io/badge/tests-29_passing-brightgreen)](https://github.com/TheAuroraAI/alive)
6+
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
57
[![Last Commit](https://img.shields.io/github/last-commit/TheAuroraAI/alive)](https://github.com/TheAuroraAI/alive/commits/main)
68

79
**Everything you need to make an AI autonomous. In one file.**
@@ -19,6 +21,10 @@ That's it. No frameworks. No dependencies beyond Python stdlib + your LLM SDK.
1921

2022
---
2123

24+
**Contents:** [Quick Start](#quick-start) · [How It Works](#what-this-is) · [Soul File](#the-soul-file) · [Memory](#memory) · [Communication](#communication) · [Dashboard](#dashboard) · [Controls](#controls) · [Providers](#llm-providers) · [Deployment](#deployment) · [Philosophy](#philosophy)
25+
26+
---
27+
2228
## What It Looks Like
2329

2430
```
@@ -251,6 +257,44 @@ python3 -m pytest test_alive.py -v
251257

252258
29 tests covering all core functions: token estimation, wake intervals, kill phrase detection, sleep-until, memory reading, context building, session continuity, SIGTERM handling, and metrics logging.
253259

260+
## Deployment
261+
262+
**systemd** (recommended for production):
263+
264+
```ini
265+
# /etc/systemd/system/alive.service
266+
[Unit]
267+
Description=alive autonomous AI
268+
After=network.target
269+
270+
[Service]
271+
Type=simple
272+
User=ai
273+
WorkingDirectory=/home/ai/alive
274+
ExecStart=/usr/bin/python3 alive.py --dashboard
275+
Restart=on-failure
276+
RestartSec=10
277+
278+
[Install]
279+
WantedBy=multi-user.target
280+
```
281+
282+
```bash
283+
sudo systemctl enable alive
284+
sudo systemctl start alive
285+
```
286+
287+
**Docker**:
288+
289+
```dockerfile
290+
FROM python:3.12-slim
291+
WORKDIR /app
292+
COPY alive.py soul.md .env ./
293+
RUN mkdir -p memory comms logs/sessions
294+
EXPOSE 7600
295+
CMD ["python3", "alive.py", "--dashboard"]
296+
```
297+
254298
## Philosophy
255299

256300
Most AI agent frameworks are complex because they try to do everything. Alive is simple because it only does one thing: **keep the AI breathing**.

0 commit comments

Comments
 (0)