Skip to content

fum4/openkit

Repository files navigation

OpenKit app icon

OpenKit

OpenKit provides developers with a simple, centralized way to manage their agents and control how they operate across different projects.

Rather than enforcing a predefined workflow structure, OpenKit gives you the flexibility to design your own.

You can experiment, analyze the results, and continuously refine your approach until it works exactly the way you need. We believe this flexibility is the true strength of OpenKit—especially in a landscape where AI best practices are evolving so quickly.

Check the official docs for more info and usage patterns.


⚠️ This project is in an early stage, so expect bugs and be cautious!



🏗 Setup

Tip

The easiest way to set up OpenKit is to download the app and follow the instructions.

You will be up and running in no time. 👍


Alternatively, you can clone the repo and set it up locally:

Prerequisites:

  • Node.js >= 18 (LTS recommended)
  • pnpm == 10.30.1
  • Zig >= 0.15
  • Go >= 1.21
  • TinyGo >= 0.30
  • Homebrew (optional, for automatic dependency installation on macOS)

Run the setup script

On macOS, the script handles everything — including installing any missing prerequisites via Homebrew. Just run:

$ pnpm run setup
# or
$ npm run setup
# or
$ bash scripts/setup.sh

The setup script will:

  • Check for required dependencies and offer to install missing ones via Homebrew
  • Enable Corepack for pnpm
  • Create .env.local from .env.example
  • Install pnpm dependencies
  • Build all apps and shared libs



🏃🏻‍♂️ Run the app

Run all apps:

$ pnpm dev

Run specific apps:

$ pnpm dev:cli
$ pnpm dev:server
$ pnpm dev:website
$ pnpm dev:web-app
$ pnpm dev:desktop-app
$ pnpm dev:mobile-app



⚙️ Build

$ pnpm build
$ pnpm build:cli
$ pnpm build:server
$ pnpm build:website
$ pnpm build:web-app
$ pnpm build:desktop-app
$ pnpm build:mobile-app

Environment variables:

  • OPENKIT_SERVER_PORT (default 6969) — backend server base port
  • OPENKIT_WEB_APP_PORT (default 5173) — web-app Vite dev server port



📦 Package

$ pnpm package
$ pnpm package:mac
$ pnpm package:linux # work in progress



🚀 Deploy

Everything is released from master.

  • On pull requests targeting master, CI runs code quality, type checks, smoke and unit tests, and build jobs with affected-target guards.
  • On push/merge to master, the release workflow creates the release commit/tag and GitHub release if desktop-app (or its packaging dependencies) is affected.
  • A dedicated package workflow runs on release tag pushes and attaches macOS/Linux artifacts to that tag.



📚 Docs



❤️ Contributions

Not yet, we are still figuring things out for ourselves.

Building the pipeline

About

The platform for your agents.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors