Your proactive AI companion
We at Existence believe that AI won't simply die as a fad or remain limited to an assistant. Instead, it will evolve to be a true companion of humans, and our aim with Sentient is to contribute to that future. Building a true companion requires excellent automation which in turn requires deep personalization. And if we want the AI to be completely context-aware of the user, privacy is non-negotiable. Hence, we aim to build a proactive & interactive AI companion. And we want to build it in the open, not behind closed doors, with transparency as a core pillar.
Context is streamed in from your apps - Sentient uses this context to 👇
Learn Long-Term Memories about you
Learn Short-Term Memories about you
Perform Actions for you, asynchronously and by combining all the different tools it needs to complete a task.
You can also voice-call Sentient anytime for a low-latency, human-like interactive experience.
Your profile can also be enriched with data from other social media sites.
Choose your path below.
If you're here to contribute to Sentient—adding features, fixing bugs, improving docs—follow these steps on the default branch.
Clone the repo
git clone https://github.com/existence-master/Sentient.git
cd Sentient
Prerequisites
Frontend setup
cd src/client
npm install
Backend setup
cd src/server
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
⚠️ If you encounter numpy errors, first install with the latest numpy (2.x), then downgrade to 1.26.4.
Ollama models
ollama pull llama3.2:3b
Tip: To use another model, update BASE_MODEL_REPO_ID
in your .env
accordingly.
Neo4j APOC plugin
Copy apoc-x.x.x-core.jar
into neo4j/plugins
.
In neo4j/conf/neo4j.conf
:
dbms.security.procedures.unrestricted=apoc.*
dbms.security.procedures.allowlist=apoc.*
dbms.unmanaged_extension_classes=apoc.export=/apoc
Environment variables
Frontend: create src/interface/.env
:
ELECTRON_APP_URL="http://localhost:3000"
APP_SERVER_URL="http://127.0.0.1:5000"
NEO4J_SERVER_URL="http://localhost:7474"
BASE_MODEL_REPO_ID="llama3.2:3b"
AUTH0_DOMAIN="your-auth0-domain"
AUTH0_CLIENT_ID="your-auth0-client-id"
Backend: create src/server/.env
:
NEO4J_URI=bolt://localhost:7687
NEO4J_USERNAME=neo4j
NEO4J_PASSWORD=your-password
EMBEDDING_MODEL_REPO_ID=sentence-transformers/all-MiniLM-L6-v2
BASE_MODEL_URL=http://localhost:11434/api/chat
BASE_MODEL_REPO_ID=llama3.2:3b
GOOGLE_CLIENT_ID=…
GOOGLE_CLIENT_SECRET=…
BRAVE_SUBSCRIPTION_TOKEN=…
AES_SECRET_KEY=…
AES_IV=…
⚠️ If you need example keys, see the discussion “Request Environment Variables” in Issues.
Run everything
Start Neo4j:
cd neo4j/bin && ./neo4j console
Start backend:
cd src/server
source venv/bin/activate
python -m server.app.app
Start Electron client:
cd src/client
npm run dev
If you just want to self-host Sentient—no contributions needed—switch to the self-host
branch. The instructions are identical to the contributors guide above, but this branch is tailored for self-hosting deployments.
Switch branches
git clone https://github.com/existence-master/Sentient.git
cd Sentient
git checkout self-host
Follow all steps in the Contributors section above, starting at “Prerequisites.”
Tip: The
self-host
branch will always mirror the default branch’s setup instructions. Any updates to installation or configuration in the default branch will be back-ported here for self-hosting users.
Sentient is a proactive companion that pulls context from the different apps you use and uses that context to remember new information about you, perform tasks for you like sending emails, creating docs and more. The goal of this personal companion is to take over the mundane tasks in your life to let you focus on what matters.
Sentient can also do a lot based on simple user commands.
"Hey Sentient, help me find a restaurant in Pune based on my food preferences.
What are the upcoming events in my Google Calendar?
Setup a lunch meeting with [email protected] and add it to my Calendar
Create a pitch deck for my startup in Google Slides and email it to [email protected]
Help me find new hobbies in my city
Contributions are always welcome!
See the contributing guide for ways to get started.
Please read the code of conduct
When will the cloud version launch? We are working as fast as we can to bring it to life! Join our WhatsApp Community to get daily updates and more!
What data do you collect about me? For auth, we have a standard email–password flow provided by Auth0 (also supports Google OAuth). We only collect your email and login history. Read more in our privacy policy.
What hardware do I need?
Why open source & AGPL? Transparency around personal data is core to our philosophy. AGPL ensures derivatives also remain open, preventing closed-source forks.
Distributed under the GNU AGPL License. See LICENSE.txt for details.
Sentient wouldn't have been possible without:
No configuration available
Related projects feature coming soon
Will recommend related projects based on sub-categories