XMem
Xmem is a India's First open source multi-modal, multi-agentic long‑term memory layer for AI agents.
File Explorer
Download Latest Version (.zip)- api-schema-diff.yml
- danger.yml
- deploy-aws.yml
- deploy-go.yml
- deploy-staging.yml
- docker-build-check.yml
- labeler.yml
- promote-to-production.yml
- security-scan.yml
- tests.yml
- CODEOWNERS
- labeler.yml
- PULL_REQUEST_TEMPLATE.md
- app.js
- index.html
- style.css
- __init__.py
- config.py
- dataset.py
- evaluate.py
- README.md
- run.py
- runner.py
- __init__.py
- io.py
- metrics.py
- xmem.py
- __init__.py
- config.py
- dataset.py
- README.md
- run.py
- runner.py
- __init__.py
- client.py
- config.py
- dataset.py
- metrics.py
- README.md
- run.py
- run_all_categories.py
- runner.py
- README.md
- docker-compose.dev.yml
- docker-compose.yml
- Dockerfile
- api-reference.md
- architecture.md
- benchmarks.md
- configuration.md
- contributing.md
- getting-started.md
- create-xmem.js
- package.json
- plugin.json
- index.md
- logout.md
- project-config.md
- session.md
- hooks.json
- plugin-utils.cjs
- xmem-client.cjs
- add-memory.cjs
- context-hook.cjs
- save-project-memory.cjs
- search-memory.cjs
- summary-hook.cjs
- SKILL.md
- SKILL.md
- package.json
- README.md
- plugin.json
- index.md
- logout.md
- project-config.md
- session.md
- hooks.json
- plugin-utils.cjs
- xmem-client.cjs
- add-memory.cjs
- context-hook.cjs
- save-project-memory.cjs
- search-memory.cjs
- summary-hook.cjs
- SKILL.md
- SKILL.md
- package.json
- README.md
- plugin.json
- xmem-client.cjs
- save-memory.cjs
- search-memory.cjs
- status.cjs
- SKILL.md
- SKILL.md
- SKILL.md
- package.json
- README.md
- mcp.json
- plugin.json
- xmem-config.md
- xmem-logout.md
- xmem-setup.md
- hooks.json
- xmem.mdc
- xmem-client.cjs
- mcp-server.cjs
- session-end.cjs
- session-start.cjs
- status.cjs
- SKILL.md
- SKILL.md
- SKILL.md
- .mcp.json
- package.json
- README.md
- cli.js
- cli.test.js
- package.json
- README.md
- cli.ts
- slash.ts
- capture.ts
- recall.ts
- search.ts
- status.ts
- store.ts
- client.ts
- config.ts
- index.ts
- logger.ts
- memory.ts
- openclaw.plugin.json
- package.json
- README.md
- runtime.ts
- auth.ts
- client.ts
- compaction.ts
- context.ts
- jsonc.ts
- logger.ts
- privacy.ts
- tags.ts
- index.ts
- cli.ts
- config.ts
- index.ts
- .gitignore
- bun.lock
- package.json
- README.md
- tsconfig.json
- benchmark_v2_ingest.py
- check-npm-publish.js
- context.py
- patch-extension-local.js
- verify.py
- xmem.js
- __init__.py
- base.py
- classifier.py
- code.py
- image.py
- judge.py
- profiler.py
- snippet.py
- summarizer.py
- temporal.py
- __init__.py
- activities.py
- jobs.py
- memory.py
- scanner.py
- secrets.py
- shared.py
- temporal_client.py
- worker.py
- workflows.py
- __init__.py
- admin.py
- api_keys.py
- auth.py
- billing.py
- code.py
- connectors.py
- enterprise.py
- health.py
- memory.py
- memory_graph.py
- scanner.py
- telemetry.py
- __init__.py
- app.py
- dependencies.py
- middleware.py
- schemas.py
- __init__.py
- context.py
- metering.py
- pricing.py
- razorpay.py
- service.py
- store.py
- types.py
- __init__.py
- analytics.py
- constants.py
- effort.py
- logging.py
- metrics.py
- monitoring.py
- settings.py
- __init__.py
- api_key_store.py
- models.py
- project_store.py
- user_store.py
- __init__.py
- annotation_service.py
- chat_orchestrator.py
- memory_service.py
- schemas.py
- __init__.py
- code_graph_client.py
- code_schema.py
- neo4j_client.py
- schema.py
- welcome.py
- __init__.py
- durable.py
- __init__.py
- base.py
- bedrock.py
- claude.py
- deepseek.py
- gemini.py
- groq.py
- mimo.py
- ollama.py
- openai.py
- openrouter.py
- registry.py
- __init__.py
- code_retrieval.py
- ingest.py
- retrieval.py
- weaver.py
- classification.py
- judge.py
- profile.py
- retrieval.py
- summary.py
- temporal.py
- classifier.py
- classifier_keywords.py
- code.py
- image.py
- judge.py
- profiler.py
- profiler_topics.py
- retrieval.py
- snippet.py
- summarizer.py
- temporal.py
- __init__.py
- ast_parser.py
- code_store.py
- enricher.py
- git_ops.py
- indexer.py
- runner.py
- __init__.py
- ast_parser.py
- embedder.py
- enricher.py
- git_ops.py
- indexer.py
- runner.py
- schemas.py
- store.py
- classification.py
- code.py
- events.py
- image.py
- judge.py
- profile.py
- retrieval.py
- summary.py
- weaver.py
- __init__.py
- base.py
- factory.py
- local.py
- pinecone.py
- team_annotation_store.py
- __init__.py
- billing.py
- exceptions.py
- retry.py
- text.py
- xmem.env.local
- test_app_errors.py
- test_billing_routes.py
- test_connectors.py
- test_dependencies_and_routes.py
- test_memory_versioning.py
- test_memory_flow.py
- test_code_retrieval_pipeline.py
- test_ingest_pipeline.py
- test_retrieval_pipeline.py
- test_weaver_pipeline.py
- test_agents.py
- test_billing_config.py
- test_database_stores.py
- test_provider_settings.py
- test_schemas.py
- test_utils.py
- conftest.py
- test_billing.py
- test_deterministic_memory_layer.py
- test_durable_jobs.py
- test_enterprise_chat.py
- test_v2_review_fixes.py
- main.go
- trace.go
- bootstrap.go
- main.go
- docker-compose.dev.yml
- Dockerfile
- configuration.md
- agents_test.go
- base.go
- classifier.go
- code.go
- helpers.go
- image.go
- judge.go
- profiler.go
- snippet.go
- summarizer.go
- temporal.go
- auth.go
- health.go
- memory_handlers.go
- memory_middleware.go
- middleware.go
- rate_limiter.go
- response.go
- server.go
- server_test.go
- types.go
- validation.go
- config.go
- types.go
- api_keys.go
- durable_jobs.go
- mongo.go
- memory.go
- neo4j.go
- types.go
- attempt.go
- durable.go
- durable_test.go
- memory_store.go
- payload.go
- runner.go
- models.go
- effort.go
- effort_test.go
- ingest.go
- retrieval.go
- classifier.go
- classifier_keywords.go
- code.go
- constants.go
- image.go
- judge.go
- profiler.go
- profiler_topics.go
- retrieval.go
- snippet.go
- summarizer.go
- temporal.go
- memory.go
- openai.go
- pinecone.go
- types.go
- retry.go
- text.go
- types.go
- weaver.go
- weaver_test.go
- .env.example
- .gitignore
- go.mod
- go.sum
- README.md
- .env.example
- .gitattributes
- .gitignore
- Aptfile
- benchmark.py
- CHANGELOG.md
- CONTRIBUTING.md
- Dangerfile.js
- docker-compose.local.yml
- Dockerfile
- LICENSE
- Local.md
- package.json
- Procfile
- pyproject.toml
- README.hi.md
- README.ja.md
- README.md
- README.zh-CN.md
- server.py
- setup.py
- uv.lock
# Installation Guide
1. Get the code
git clone https://github.com/XortexAI/XMem
Downloads the entire project code from GitHub to your computer.
cd XMem
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker-compose.local.yml up -d --build
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
npm run dev
Starts the development/run server.
npm run setup
Type this command into your terminal and run it.
npm run start
Starts the development/run server.
npm run verify
Type this command into your terminal and run it.
npm run doctor
Type this command into your terminal and run it.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
4. Python
EasyPrerequisites
pip install -e ".[local]"
Installs the Python libraries listed in requirements.txt (or similar).
python -m src.scanner.runner \
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
5. Go
MediumPrerequisites
cd xmem-go
This project's files live in a subfolder, so move into it first.
go build ./...
Compiles the Go program into an executable.
go run .
Runs the Go program directly without a separate build step.
If the build finishes without errors, it worked. If you used go run ., check the terminal output.
// repository documentation
Was this content helpful?
(0 ratings)