README.md27 lines · main

1	# @briven/api — control plane
2
3	Hono on Bun. The control plane for briven: accounts, projects, billing, auth, CLI sessions, env vars, audit logs. Customer data queries never hit this service.
4
5	## dev
6
7	```bash
8	# from the repo root
9	pnpm install
10	pnpm --filter @briven/api dev
11	```
12
13	requires bun 1.1+. the dev script uses `bun --hot` for live reload.
14
15	## endpoints (phase 0)
16
17	\| path \| description \|
18	\| ------------- \| -------------------------------------------- \|
19	\| `GET /` \| liveness + service identity \|
20	\| `GET /health` \| process alive \|
21	\| `GET /ready` \| dependencies reachable (stubs until phase 1) \|
22
23	phase 1 adds auth, projects, deployments, api-keys — see `docs/BUILD_PLAN.md` §Phase 1.
24
25	## env
26
27	see `src/env.ts` for the full schema. all vars carry the `BRIVEN_` prefix per `CLAUDE.md §4`.

Preview

@briven/api — control plane

Hono on Bun. The control plane for briven: accounts, projects, billing, auth, CLI sessions, env vars, audit logs. Customer data queries never hit this service.

dev

# from the repo root
pnpm install
pnpm --filter @briven/api dev

requires bun 1.1+. the dev script uses bun --hot for live reload.

endpoints (phase 0)

path	description
`GET /`	liveness + service identity
`GET /health`	process alive
`GET /ready`	dependencies reachable (stubs until phase 1)

phase 1 adds auth, projects, deployments, api-keys — see docs/BUILD_PLAN.md §Phase 1.

env

see src/env.ts for the full schema. all vars carry the BRIVEN_ prefix per CLAUDE.md §4.