Metadata-Version: 2.4
Name: amie
Version: 1.17.0
Summary: Your private memory intelligence — captures thoughts from anywhere, organises them into your vault, and reflects insights back to you. Entirely local.
Project-URL: Documentation, https://gitlab.com/nkosinathi1/amie/-/tree/main/docs
Project-URL: Issues, https://gitlab.com/nkosinathi1/amie/-/issues
Project-URL: Source, https://gitlab.com/nkosinathi1/amie
Author-email: nk0s1 <nkosinathi@whakatau.com>
License-Expression: MIT
License-File: LICENSE
Keywords: knowledge-management,local-ai,notes,obsidian,ocr,ollama
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Office/Business :: News/Diary
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Utilities
Requires-Python: >=3.12
Requires-Dist: fastapi>=0.115
Requires-Dist: idna>=3.15
Requires-Dist: msgpack>=1.2.1
Requires-Dist: ollama>=0.6.2
Requires-Dist: pillow-heif>=1.3.0
Requires-Dist: platformdirs>=4.0
Requires-Dist: psutil>=5.9
Requires-Dist: python-dotenv>=1.2.2
Requires-Dist: python-frontmatter>=1.1.0
Requires-Dist: typer>=0.25.1
Requires-Dist: urllib3>=2.7.0
Requires-Dist: uvicorn[standard]>=0.32
Requires-Dist: watchdog>=6.0.0
Description-Content-Type: text/markdown

# amie — Anonymous Memory Intelligence

Your private memory intelligence. Captures thoughts from anywhere, organises them
into your Obsidian vault, and reflects insights back to you — entirely on your own
hardware. No cloud services, no subscriptions.

---

## Install

Pick your platform:

- **Linux / WSL2** → [docs/install-linux.md](docs/install-linux.md)
- **Windows (native)** → [docs/install-windows.md](docs/install-windows.md)

Quick path (Linux/WSL2):

```bash
# 1. Install uv and Ollama first (see docs/install-linux.md)
uv tool install amie
amie init
amie check health
```

Quick path (Windows, elevated PowerShell):

```powershell
# 1. Install Python, uv, and Ollama first (see docs/install-windows.md)
uv tool install amie
amie init
amie check health
```

---

## Dashboard

```bash
export AMIE_VAULT_PATH=/path/to/your/vault
amie dashboard serve --open
```

Opens a local web UI at `http://127.0.0.1:8765`. See [docs/dashboard.md](docs/dashboard.md).

---

## CLI overview

```
amie init              first-time setup — vault, SSH, Syncthing
amie check health      verify everything is ready
amie watch start       start the background inbox watcher
amie digest weekly     generate a weekly digest
amie dashboard serve   launch the web dashboard
amie doctor            detailed health report
amie --help            full command reference
```

---

## Requirements

| Requirement | Notes |
|---|---|
| Python 3.12+ | Ships with Ubuntu 24.04; winget on Windows |
| [uv](https://docs.astral.sh/uv/) | Package manager — single binary install |
| [Ollama](https://ollama.com) | Local LLM runner — models stay on your device |
| [Obsidian](https://obsidian.md) | Vault host — any existing vault works |

---

## License

MIT. See `LICENSE`.
