Skip to main content
Reminix automatically detects your project setup. This page covers entrypoints, build steps, and package managers.

Entrypoint

Reminix looks for these files at the root of your project:
TypeScript/JavaScriptPython
server.ts, server.jsserver.py
agent.ts, agent.jsagent.py
index.ts, index.jsmain.py
If found, we run them directly (tsx server.ts, node server.js, python main.py).

Custom Entrypoint

For code in subfolders or modules, add a start script:
package.json
{
  "scripts": {
    "start": "node dist/index.js"
  }
}

Build Step

If your package.json has a build script, it runs automatically before starting your agent.
package.json
{
  "scripts": {
    "build": "tsc",
    "start": "node dist/index.js"
  }
}
Python projects typically don’t need a build step.

Package Manager

Node.js

We detect your package manager in this order:
  1. packageManager field in package.json (recommended)
  2. Lockfile: bun.lockbpnpm-lock.yamlyarn.lockpackage-lock.json
  3. Default: npm
package.json
{
  "packageManager": "[email protected]"
}

Python

We detect your package manager in this order:
  1. Lockfile: uv.lockpoetry.lock
  2. requirements.txt
  3. pyproject.toml with [tool.poetry] or [tool.uv]
  4. PEP 621 pyproject.toml with [project]

Lockfiles

Include your lockfile for faster, reproducible builds:
Package ManagerLockfile
npmpackage-lock.json
pnpmpnpm-lock.yaml
yarnyarn.lock
bunbun.lockb
poetrypoetry.lock
uvuv.lock
piprequirements.txt (pinned)

Required Packages

Your project must include at least one Reminix package:
TypeScriptPython
@reminix/runtimereminix-runtime
@reminix/langchainreminix-langchain
@reminix/langgraphreminix-langgraph
@reminix/openaireminix-openai
@reminix/anthropicreminix-anthropic
@reminix/vercel-aireminix-llamaindex
Install the latest version — check npm or PyPI for current versions.