augure 0.1.0 → 0.3.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 +60 -0
- package/dist/bin.js +3455 -16
- package/package.json +40 -19
- package/dist/bin.d.ts +0 -3
- package/dist/bin.d.ts.map +0 -1
- package/dist/bin.js.map +0 -1
- package/dist/commands/init.d.ts +0 -2
- package/dist/commands/init.d.ts.map +0 -1
- package/dist/commands/init.js +0 -107
- package/dist/commands/init.js.map +0 -1
- package/dist/commands/start.d.ts +0 -9
- package/dist/commands/start.d.ts.map +0 -1
- package/dist/commands/start.js +0 -29
- package/dist/commands/start.js.map +0 -1
package/README.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# augure
|
|
2
|
+
|
|
3
|
+
A personal AI agent that sees, learns & acts. Deploy in 5 minutes. Own your data.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/augure)
|
|
6
|
+
[](https://github.com/FaureAlexis/augure/blob/master/LICENSE)
|
|
7
|
+
[](https://github.com/FaureAlexis/augure/actions)
|
|
8
|
+
|
|
9
|
+
## Quick Start
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install -g augure
|
|
13
|
+
augure init # generates augure.json5 + .env
|
|
14
|
+
augure start # start the agent
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Or with Docker Compose:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
git clone https://github.com/FaureAlexis/augure.git && cd augure
|
|
21
|
+
cp .env.example .env
|
|
22
|
+
cp config/augure.example.json5 config/augure.json5
|
|
23
|
+
docker compose up -d
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## What is Augure?
|
|
27
|
+
|
|
28
|
+
Augure is an open-source AI agent built on six primitives: **think, execute, remember, communicate, watch, learn**. It runs 24/7 on your server, connects to your messaging apps, learns your preferences, and acts proactively on a schedule.
|
|
29
|
+
|
|
30
|
+
- **Filesystem-first** — Memory, config, logs: everything is human-readable files. No vector DB.
|
|
31
|
+
- **Proactive** — Cron jobs, heartbeat monitoring, and actions on your behalf 24/7.
|
|
32
|
+
- **Secure by default** — All execution in Docker containers. Credentials never touch disk.
|
|
33
|
+
- **Self-improving** — Generates reusable skills, tests them, and auto-heals on failure.
|
|
34
|
+
- **Cost-aware** — Per-usage model routing. Cheap models for monitoring, full models for reasoning.
|
|
35
|
+
- **Readable** — Under 5K lines of source code.
|
|
36
|
+
|
|
37
|
+
## Commands
|
|
38
|
+
|
|
39
|
+
| Command | Description |
|
|
40
|
+
|---------|-------------|
|
|
41
|
+
| `augure init` | Generate `augure.json5` and `.env` templates |
|
|
42
|
+
| `augure start` | Start the agent |
|
|
43
|
+
| `augure start --config path/to/config.json5` | Start with a custom config path |
|
|
44
|
+
| `augure --version` | Print version |
|
|
45
|
+
| `augure --help` | Show help |
|
|
46
|
+
|
|
47
|
+
## Configuration
|
|
48
|
+
|
|
49
|
+
`augure init` generates two files:
|
|
50
|
+
|
|
51
|
+
- **`augure.json5`** — Agent config: identity, LLM provider, channels, memory, scheduler, tools, sandbox, skills, security
|
|
52
|
+
- **`.env`** — API keys (`OPENROUTER_API_KEY`, `TELEGRAM_BOT_TOKEN`)
|
|
53
|
+
|
|
54
|
+
## Documentation
|
|
55
|
+
|
|
56
|
+
Full docs at **[augure.dev](https://augure.dev)**
|
|
57
|
+
|
|
58
|
+
## License
|
|
59
|
+
|
|
60
|
+
[MIT](https://github.com/FaureAlexis/augure/blob/master/LICENSE)
|