​

Installing EchOS

​

Quick Install (Recommended)

​

One-liner (macOS + Linux)

curl -sSL https://raw.githubusercontent.com/albinotonnina/echos/main/install.sh | bash

1. Install Node.js 20+ via Homebrew / apt / dnf if not present
2. Install pnpm if not present
3. Clone the repository
4. Install dependencies (prebuilt native modules, no C++ toolchain needed)
5. Build all packages
6. Launch the setup wizard

​

Homebrew (macOS)

brew tap albinotonnina/echos
brew install echos

• Installs Node.js 20 and Redis as dependencies
• Builds all packages with prebuilt native modules
• Registers a launchd service for auto-start

echos-setup                # opens browser-based setup wizard
brew services start echos  # start the daemon
echos "search my notes"    # use the CLI

​

Docker

cd docker
docker compose up -d

​

Manual Install

git clone https://github.com/albinotonnina/echos.git && cd echos
pnpm install
pnpm build

​

Setup Wizard

​

Browser-based Setup (Recommended)

pnpm wizard

• API keys (Anthropic required, OpenAI optional)
• Telegram bot configuration
• Feature toggles (Web UI)
• Redis connection

​

CLI Setup

pnpm wizard:cli

​

Non-interactive Setup

# Set environment variables, then:
pnpm wizard:cli --non-interactive

​

Dependencies

​

Required

• Node.js 20+ — runtime
• pnpm 10+ — package manager
• Redis — background scheduler (digests, reminders, cron jobs)

​

What you DON’T need

• No C++ toolchain — all native modules (better-sqlite3, LanceDB, sharp) ship prebuilt binaries
• No Python — YouTube transcript extraction uses a pure JavaScript library

​

Native Modules

​

Starting EchOS

# Start the daemon (Telegram + Web interfaces)
pnpm start

# Start with pretty-printed logs
pnpm start | pnpm exec pino-pretty

# Use the CLI (no daemon needed)
pnpm echos "what did I save yesterday?"

​

Stopping EchOS

brew services stop echos

# Restart
brew services restart echos

# Check status
brew services info echos

# If running in foreground, press Ctrl+C

# If running via pm2
pm2 stop echos
pm2 restart echos

cd docker
docker compose stop      # stop
docker compose restart   # restart

​

Updating

brew update
brew upgrade echos

# Verify the new version
echos --version

# Restart if needed
brew services restart echos

cd echos

# Stop the running daemon first
# (Ctrl+C if foreground, or pm2 stop echos, or systemctl stop echos)

git pull
pnpm install
pnpm build

# Restart
pnpm start

cd echos
git pull
cd docker
docker compose down
docker compose up -d --build

​

Checking your version

# CLI
echos --version

# Or from the repo (from the EchOS repo root)
cd echos          # or the path to your cloned repo
git fetch --tags  # ensure tags are available locally
git describe --tags --abbrev=0

​

Future Distribution Methods

• Tauri desktop app — .dmg for macOS with menu bar icon and auto-updates
• Docker Desktop Extension — one-click install from Docker Hub
• npm global package — npm install -g echos