From d063ee675f699f12e9546735aed21d52fcd730aa Mon Sep 17 00:00:00 2001 From: Charles Packer Date: Wed, 11 Dec 2024 13:39:40 -0800 Subject: [PATCH] fix: Update README.md asset URLs to be absolute (#2227) --- README.md | 38 +++++++++++++++++++++++++------------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 877e5d0a1b..b73622f6a9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@

- - - Letta logo + + + Letta logo

@@ -13,9 +13,9 @@

- - - Letta logo + + + Letta logo

@@ -51,7 +51,7 @@ ## ⚡ Quickstart -_The recommended way to use Letta is to run use Docker. To install Docker, see [Docker's installation guide](https://docs.docker.com/get-docker/). For issues with installing Docker, see [Docker's troubleshooting guide](https://docs.docker.com/desktop/troubleshoot-and-support/troubleshoot/). You can also install Letta using `pip` (see guide [below](#-quickstart-pip))._ +_The recommended way to use Letta is to run use Docker. To install Docker, see [Docker's installation guide](https://docs.docker.com/get-docker/). For issues with installing Docker, see [Docker's troubleshooting guide](https://docs.docker.com/desktop/troubleshoot-and-support/troubleshoot/). You can also install Letta using `pip` (see instructions [below](#-quickstart-pip))._ ### 🌖 Run the Letta server @@ -89,9 +89,9 @@ Once the Letta server is running, you can access it via port `8283` (e.g. sendin

- - - Letta logo + + + ADE screenshot

@@ -104,9 +104,9 @@ To connect the ADE with your local Letta server, simply:

- - - Letta logo + + + Letta logo

@@ -135,6 +135,18 @@ If your Letta server isn't running on `localhost` (for example, you deployed it No, you can install Letta using `pip` (via `pip install -U letta`), as well as from source (via `poetry install`). See instructions below. +> _"What's the difference between installing with `pip` vs `Docker`?"_ + +Letta gives your agents persistence (they live indefinitely) by storing all your agent data in a database. Letta is designed to be used with a [PostgreSQL](https://en.wikipedia.org/wiki/PostgreSQL) (the world's most popular database), however, it is not possible to install PostgreSQL via `pip`, so the `pip` install of Letta defaults to using [SQLite](https://www.sqlite.org/). If you have a PostgreSQL instance running on your own computer, you can still connect Letta (installed via `pip`) to PostgreSQL by setting the environment variable `LETTA_PG_URI`. + +**Database migrations are not officially supported for Letta when using SQLite**, so you would like to ensure that if you're able to upgrade to the latest Letta version and migrate your Letta agents data, make sure that you're using PostgreSQL as your Letta database backend. Full compatability table below: + +| Installation method | Start server command | Database backend | Data migrations supported? | +|---|---|---|---| +| `pip install letta` | `letta server` | SQLite | ❌ | +| `pip install letta` | `export LETTA_PG_URI=...` + `letta server` | PostgreSQL | ✅ | +| *[Install Docker](https://www.docker.com/get-started/)* |`docker run ...` ([full command](#-run-the-letta-server)) | PostgreSQL | ✅ | + > _"How do I use the ADE locally?"_ To connect the ADE to your local Letta server, simply run your Letta server (make sure you can access `localhost:8283`) and go to [https://app.letta.com](https://app.letta.com). If you would like to use the old version of the ADE (that runs on `localhost`), downgrade to Letta version `<=0.5.0`.