Skip to main content
If you’re on macOS or a Debian-based Linux distro you can use our one-liner install script.

Prerequisites

  • Claude Code installed and authenticated
  • gh CLI installed and authenticated
  • git installed and configured

Install

curl -fsSL https://raw.githubusercontent.com/yakkomajuri/konduktor-oss/main/install.sh | bash
If you’re on another OS, follow the manual installation steps.
Konduktor runs on a machine you own, be it your laptop or a VPS. However, you’re strongly recommended to deploy this on a remote machine behind a domain so that you can benefit from GitHub webhooks, run agents overnight (without any hassle), and let the agents operate more freely away from your personal stuff.

What GitHub user should I use?

We’ve seen Konduktor users use Konduktor in two ways:
  1. With their personal user
  2. With a separate dedicated bot user
It’s up to you which one you use. Using your personal user will give you proper commit attribution to commits made by Konduktor.

Token type and permissions

We recommend you authenticate into the gh CLI using a fine-grained token that you can create from the GitHub Personal Tokens settings page. No account permissions are necessary. At a minimum, you’ll need the following repository permissions on all repos or the repos you want Konduktor to be able to access:
  • Contents (read and write)
  • Pull requests (read and write)
You might also choose to give other permissions that can be useful:
  • Issues (if you want Konduktor to be able to read and action on issues)
  • Workflows (if you want Konduktor to be able to edit CI)
  • Pages (if you’re using Konduktor with GitHub Pages)
  • Actions (if you want Konduktor to be able to inspect Actions runs)
You can sync git credentials with your gh user by running gh auth setup-git.

What the script does

The script will show you what it’s doing at every step. It:
  • Checks that you have the prerequisites installed (gh CLI, Claude Code, and git)
  • If opted into, sets up nginx reverse proxying to make the service available to the internet
  • If opted into, configures a domain for your Konduktor instance and issues a TLS certificate for HTTPS access
  • Installs Python (if not already installed)
  • Installs uv (if not already installed)
  • Installs Node.js (if not already installed)
  • Installs pnpm (if not already installed)
  • Installs dependencies
  • Installs the konduktor-server CLI, used to manage the server and run updates
  • Builds the UI
  • Sets up a systemd service for the Konduktor service (Linux)
  • Installs the konduktor CLI, for interacting with the Konduktor API

Next steps

After installation, you should: Install the Konduktor CLI locally on your machine In case you’re running Konduktor on a remote machine, you’ll need to install the CLI on your local machine in order to execute commands against your Konduktor instance.
npm install -g konduktor
This will allow you to do anything you can do with the Konduktor UI such as creating and running tasks, editing projects, setting up scheduled agents, managing the board, etc. And, not only will it be available to you, but also to your terminal coding agents, who can execute Konduktor actions for you. And I’ll tell you right now, this is the best way to do thigs like create a project from a feature spec. Verify it’s installed correctly and then login:
konduktor -v
konduktor auth login
Create a workspace You can do this via the UI or using the CLI:
konduktor workspaces add org/repo
Create and run a task Again, use the UI or run the following command from the CLI:
konduktor tasks create --title "My first task" -w <workspace>
konduktor tasks run <task-id> -w <workspace> # using the task ID from the previous command

Advanced

Install location

By default Konduktor will be installed at ~/konduktor-oss. You can configure this by running the install script with the KONDUKTOR_INSTALL_DIR variable set:
KONDUKTOR_INSTALL_DIR=/some/other/dir curl -fsSL https://raw.githubusercontent.com/yakkomajuri/konduktor-oss/main/install.sh | bash

Systemd service

On Linux installs, the script automatically sets up a systemd service at /etc/systemd/system/konduktor.service. The Konduktor server will then be running on port 8080 by default.

nginx & HTTPS

If you opt into letting the script set up nginx and a domain name for you, it will set up a site at /etc/nginx/sites-enabled/konduktor (symlinked to /etc/nginx/sites-available/konduktor). The proxy will forward to http://127.0.0.1:8080 and certbot will issue a TLS certificate on the domain you point towards the Konduktor instance.