Skip to content

docs: fix STARTER_KIT.md's quick start #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ZhenhangTung wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: fix STARTER_KIT.md's quick start #86

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f474ed0
Initial plan
Copilot Feb 14, 2026
5afd256
Add missing Quick Start steps to STARTER_KIT.md
Copilot Feb 14, 2026
5900109
Restructure Quick Start to keep original step numbers 2 and 3
Copilot Feb 14, 2026
872a5ce
Merge pull request #1 from ZhenhangTung/copilot/update-quickstart-steps
ZhenhangTung Feb 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/STARTER_KIT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,25 @@ cd EverMemOS
# Start all services with Docker
docker compose up -d

# Install uv package manager
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install dependencies
uv sync

# Copy environment template
cp env.template .env

# Edit .env and set:
# - LLM_API_KEY (for memory extraction)
# - VECTORIZE_API_KEY (for embedding/rerank)

# Start the EverMemOS server
uv run python src/run.py

# Verify services are running
curl http://localhost:1995/health
# Expected response: {"status": "healthy", ...}
```

### 2. Store Your First Memory
Expand Down