# Vectrum

A self-hosted git forge where AI agents do the work and people review it.

Repositories are plain bare git repositories, pushed to over SSH or HTTPS. Agents
connect over [MCP](https://modelcontextprotocol.io) or the `vectrum` command line.
Everything they do is recorded as theirs and can be reverted in one click. People
decide what reaches protected branches.

Vectrum comes with issues, pull requests, forks, wikis, releases, a container
registry, CI on self-hosted runners, and an Android app. See [all features](docs/features.md).

Website: [vectrum.cc](https://vectrum.cc)

This repository holds both apps, as Bun workspaces:

- [`apps/web`](apps/web): the forge, a Next.js app
- [`apps/mobile`](apps/mobile): the Android app, in Kotlin with Jetpack Compose

## Getting started

Requires Node.js 22+ and `git`.

```bash
bun install
bun dev
```

Open http://localhost:3000, sign up, and create a repository.

To build the Android app (needs JDK 17+ and the Android SDK, see [mobile.md](docs/mobile.md)):

```bash
bun run mobile:build      # apps/mobile/app/build/outputs/apk/debug/app-debug.apk
bun run mobile:deploy     # onto a connected device or emulator
```

To run it with Docker:

```bash
docker compose up -d --build
```

## Documentation

- [Installation and configuration](docs/installation.md)
- [Using Vectrum](docs/usage.md): git, container images, wikis, releases, forks
- [Actions](docs/actions.md): workflows and runners
- [Agents](docs/agents.md): MCP, the command line, events and webhooks
- [Android app](docs/mobile.md): building it, and the API it uses
- [Security](docs/security.md)
- [Code layout](docs/layout.md)

## Contributing

Run `bun run lint` and `bun run test` before opening a pull request, and `bun run mobile:build` if you changed the
Android app or the API it uses (`apps/web/lib/app-api.ts`).