Skip to content
Get packs

Guide · Open source

How to use trycompai/crm: setup, agent and self-hosting

Updated · written with AI from the project's own documentation and checked against our catalogue data

trycompai/crm, also described as Comp AI CRM, is an open source customer relationship manager for tracking contacts, companies and deals. It is designed so an AI agent researches and updates records on a schedule, rather than a person filling in forms. This guide explains what the project is, what you need before installing it, how the agent and its review step work, and who should choose a different tool.

Comp AI CRMtrycompai/crm · ★ 11.8k · MIT

Quick start

  1. 1Clone the repository. Run git clone https://github.com/trycompai/crm to get the source.
  2. 2Install the prerequisites. Make sure Bun and a Postgres database are available, and have a Vercel account for the described deployment.
  3. 3Read the Quick start and Configuration sections. The README sections after the excerpt cover setup steps that are not included here.
  4. 4Set optional API keys. Add keys such as PERPLEXITY_API_KEY to enable more data sources. The agent works without them.
  5. 5Set AGENT_BRIDGE_SECRET. Use the same value in both processes to turn on the Agent tab for records.
  6. 6Review agent output. Check the Agent tab and any suggestions, since weak evidence is routed to a human.

Check whether this CRM fits your needs

The README is written for developers. Setup involves a monorepo, Bun and a Postgres database, and it describes a deployment on Vercel. If you need a ready-to-use hosted CRM, this project is not that.

The project describes its approach as new, and the README does not give maturity information. Teams that need proven, mature CRM workflows should weigh that before adopting it.

  • Good fit: teams that want an agent to research and update customer records on a schedule
  • Good fit: developers who want to self-host and experiment with agent-driven workflows
  • Good fit: organizations that prefer MIT-licensed software they can inspect and modify
  • Poor fit: non-technical users who need a hosted product
  • Poor fit: anyone who wants the agent to act with no oversight

Prepare the prerequisites

The README lists three prerequisites: Bun, Postgres, and a Vercel account for the deployment it describes. The stack is a Turborepo monorepo on Bun, deployed on Vercel, with Next.js for the front end.

Install method is clone-and-build, so you start by cloning the repository.

  • Bun
  • Postgres database
  • Vercel account (for the deployment described in the README)

Clone the repository

Run the clone command from the README to get the source code. After that, follow the Quick start and Configuration sections of the README, which the source excerpt here does not include in full.

git clone https://github.com/trycompai/crm

Understand how the agent works

The agent lives in apps/agent and is built on eve, Vercel's framework for durable agents. Tools, skills and schedules are files. The agent runs on its own schedule against a work queue, so it keeps working after you close the browser.

The agent is designed to avoid guessing. Tools report what they observe, and strong evidence writes to the record. Weak evidence becomes a suggestion that a human settles.

  • Work queue in lib/tasks.ts uses FOR UPDATE SKIP LOCKED so dispatchers take disjoint work
  • Skills such as evidence.md and identity-matching.md are markdown files the agent reads
  • The sandbox has no network and is never given DATABASE_URL

Add optional data sources

The agent works with no API keys. It reads your own threads, meetings and signature blocks through read_crm_history. Each optional key adds another source. At startup the agent prints which sources are on or off.

Company brand data and LinkedIn both come from Context and use the same key. You can change it later in Settings → General.

  • PERPLEXITY_API_KEY enables web research
  • Company brand data and LinkedIn are enabled through Settings → General
[agent] off Web research (PERPLEXITY_API_KEY) [agent] on Company brand data (Settings → General) [agent] on LinkedIn (Settings → General)

Review what the agent does

Every contact, company and deal has an Agent tab that shows the steps the agent took, the leads it discarded and why, and any questions it has. Set AGENT_BRIDGE_SECRET to the same value in both processes to enable the tab. Without it, the tab reports that it is not configured and the agent keeps running.

For connected services, use Settings → Connections. Choose Read only when agents must not change external data. Only an owner or admin can connect, reconnect, review or disconnect a service.

  • Read only: agents must not change external data
  • Read and write: approved agent tools can make external changes
  • New or changed tools need review before an agent can use them

What people use it for

  • Have an agent check contact and company records on a schedule and fill in verified details
  • Use your own email threads, meetings and signature blocks as the main source of contact information
  • Self-host a CRM to test agent-driven workflows
  • Adapt an MIT-licensed codebase to your own internal process

Frequently asked questions

Is trycompai/crm free to use?

The project is MIT-licensed, which the README states. You can inspect and modify the code. Any costs for hosting, such as a Vercel account or Postgres database, depend on your own setup and are not described in the source.

What do I need to install trycompai crm?

The README lists Bun, Postgres and a Vercel account for the deployment it describes. You install by cloning the repository with git clone https://github.com/trycompai/crm and building from source.

Does the CRM work without API keys?

Yes. The README says the agent works with no API keys, using read_crm_history to read your own threads, meetings and signature blocks. Optional keys add more sources such as web research.

Will the agent change my records without review?

Not for weak evidence. Strong evidence writes to the record, while weak evidence becomes a suggestion for a human to decide. The Read only setting also stops agents from changing external data.

Is there a hosted version I can sign up for?

The source describes a self-hosted, clone-and-build setup. It does not describe a hosted service, so this guide does not claim one exists.

What are the alternatives to this CRM?

The analysis lists no comparable projects. Choose a mature, hosted CRM if you need proven workflows and a non-developer setup, since this project's stability is not described.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

trycompai/crm suits developers and teams who want a self-hosted, MIT-licensed CRM where an AI agent researches records and routes uncertain facts to a person. It is a poor choice for non-technical users who need a ready-made hosted product, or for teams that need mature, proven CRM workflows.

Install options & downloads