Install
The fastest paths are the five-minute quickstart or the one-line installer:
curl -fsSL https://raw.githubusercontent.com/3vilM33pl3/codifix/main/scripts/install.sh | shThe installer detects your platform, checks whether PostgreSQL is reachable, and points you at the bundled Docker stack when none is found.
The current stable release is
v2.1.0. If you are
upgrading from v1, stop here and use the Update guide
before restarting the service. The published v2.1.0 distribution remains the
stable release. This source tree is preparing the breaking v3.0.0-rc.1 rename:
its executable is codifix, while v2.1.0 installs memory. The candidate is not
published and must not be treated as a stable package or upgrade. See the
RC.1 preparation note.
Choose a platform
Linux / Debian
Install the .deb package and enable the systemd service.
macOS / Homebrew
Install via Homebrew or the native Intel/Apple Silicon .pkg.
Windows
Install the native x86_64 MSI/ZIP or use Docker Desktop/WSL2.
Codifix runs as a native background service (codifix.service on Linux, a launchd agent on macOS) that manages the database connection, curation pipeline, and embedding backends. The codifix CLI and TUI communicate with this service over a local socket, so nothing leaves your machine unless you configure an external embedding or LLM provider.
Prerequisites
You need a PostgreSQL database with the pgvector extension enabled. See PostgreSQL and pgvector for setup instructions. Optional LLM and embedding providers improve curation and semantic retrieval, but the core service works without them.
| Requirement | Why it matters | Verify |
|---|---|---|
| PostgreSQL | Durable storage for projects, captures, memories, activity, and history. | psql "$DATABASE_URL" -c "SELECT 1;" |
| pgvector | Vector storage for semantic retrieval. | psql "$DATABASE_URL" -c "SELECT extversion FROM pg_extension WHERE extname = 'vector';" |
| Stable v2.1.0 binary | CLI, TUI launcher, service management, MCP, evals. | memory --version (current release: 2.1.0) |
| v3.0.0-rc.1 source candidate | Renamed CLI and service tooling. | codifix --version (unpublished candidate) |
| Optional LLM provider | Better curation, summaries, and answer synthesis. | codifix doctor |
| Optional embedding provider | Semantic search and graph-enhanced retrieval quality. | codifix embeddings list |
Configure
cd /path/to/project
codifix wizardcodifix wizard runs the setup flow once, covering the machine configuration and, when run inside a repository, the repo-local project setup. Secrets are written outside your repository so they are never committed. Use codifix wizard --dry-run to preview every file and service action first.
Verify
codifix doctor
codifix health
codifix status --project <project-slug>doctor checks configuration and dependencies. health checks the backend service. status combines service, project, watcher, and MCP diagnostics.