Who it is forA developer who wants to contribute to UseAgent and needs a local setup that matches the project's own instructions.
The problemContributors need a working local environment before they can test a fix or pick an issue.
The outcomeA running backend and frontend on your machine, a passing typecheck, and a ready branch for a pull request.
What you need first
- A hosted UseAgent account, or a Linux host or laptop for self-hosting or running from source
- bun and Postgres 16+ with pgvector (for running from source)
- A sandbox provider key and a model key (the README says a real agent task needs both)
- Optional: a ChatGPT account to run Codex on your own plan
Steps
- Start Postgres with pgvector:
docker run -d --name useagent-pg -p 127.0.0.1:5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust pgvector/pgvector:pg16(inferred, check the README) - Set the database URL:
export DATABASE_URL=postgres://postgres@localhost:5432/postgres - Clone and enter the repository:
git clone https://github.com/useagenthq/useagent.git && cd useagent - Install dependencies in each workspace listed in the README, running
bun install --frozen-lockfilein every package and in backend and frontend. - Start the backend and frontend with
bun run dev:backendandbun run dev:frontend, then runbun run typecheck. - Read CONTRIBUTING.md, comment on an issue with the hacktoberfest label that you are taking it, and open a pull request.
Prompt for your agent
Clone https://github.com/useagenthq/useagent, start Postgres with pgvector, install dependencies in every workspace listed in the README, and run bun run typecheck. Expected output: a passing typecheck and a note on which hacktoberfest issue you would pick. Verify that bun run dev:backend starts the API on port 3201 and bun run dev:frontend serves the UI on port 3400.
Caveat. The README says a real agent task also needs a sandbox provider key and a model key, so a local setup alone will not complete an agent run.
Get 5 new use cases every morning. Free, one short email, unsubscribe anytime.
Get them freeShare: X LinkedIn Hacker News Email Copy link
Disclaimer
Deduped lists open-source repositories that belong to other people. We do not own, maintain, audit, or vouch for any of them, and a repo appearing here is not an endorsement or a safety check. The use cases, steps, and prompts are written by AI and may be incomplete, outdated, or just wrong. Where a use case is marked "Seen in the wild", we link to public posts where someone described something similar, but we have not verified those posts and the use case itself is still our AI's own write-up. Use all of this at your own risk. Only run code, commands, or agents on systems and accounts you are authorized to use, and read the code and every command before you run it, especially anything that touches credentials, files, or the network. Nothing here is professional, security, legal, or financial advice. All trademarks and project names belong to their respective owners, and their use here does not imply affiliation. Content is provided as is, without warranties of any kind. Found a mistake, a safety problem, or something you want removed? Email [email protected] and we will look at it promptly. Full disclaimer page