Skip to content

About

BuildWorld: a self-hosted CI/CD server and Jenkins alternative for build automation, pipelines, and deployments.

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

BuildWorld

A self-hosted CI/CD server and modern Jenkins alternative

Build automation · Pipeline as code · Deployment workflows · React dashboard

GitHub repository Latest release GitHub stars Documentation

English · 简体中文

BuildWorld is an open-source, self-hosted CI/CD server for continuous integration, continuous delivery, build automation, and deployment workflows. Use it as a Jenkins alternative with a web dashboard, TypeScript and YAML pipelines, an extensible plugin system, and a built-in builtin executor for local builds.

Repository: github.com/neko233-com/buildworld · Documentation: neko233-com.github.io/buildworld


Screenshots

BuildWorld build details showing the execution timeline, build chain, and live logs

Local desktop capture from 2026-07-22 (Chinese interface). This archived build view shows the execution timeline, retry chain, and live logs. Current releases have updated layouts and date formatting. Click the image to view it at full size. Screenshot notes.

Features

  • Self-hosted CI/CD: run the server and its SQLite database on infrastructure you control.
  • Pipeline as code: define pipelines in TypeScript or YAML, with validation and completion in the Monaco editor.
  • Built-in execution: the local builtin executor is the default; remote Workers remain an optional deployment choice.
  • Build dashboard: review projects, queued and running builds, recent build results, logs, artifacts, and audit history.
  • Plugin ecosystem: use build, deployment, source-control, notification, artifact, and security integrations.
  • Jenkins migration: import Jenkinsfiles, generate TypeScript DSL, compare pipeline results, and migrate in stages.
  • Operational CLI: start, pause, resume, restart, inspect, and recover the service from the command line.

Quick install

The installer uses a GitHub mirror by default. Set BUILDWORLD_GITHUB_MIRROR=off to download directly from GitHub.

macOS / Linux

curl -fsSL https://gh-proxy.com/https://raw.githubusercontent.com/neko233-com/buildworld/main/scripts/install.sh | sh
buildworld status

Windows PowerShell (install.ps1)

Run this in PowerShell to download and run the Windows one-click installer:

& ([scriptblock]::Create((
  (Invoke-WebRequest -UseBasicParsing `
    https://gh-proxy.com/https://raw.githubusercontent.com/neko233-com/buildworld/main/scripts/install.ps1).Content
)))
buildworld status

Open http://127.0.0.1:8080 and sign in with root / root. Change the default password immediately after the first login.

HTTP API automation by default

The server automatically provisions one private local API token on first start; no dashboard switch is required. Its file is <database.path>.http-token (0600 on Unix). SQLite stores only its hash. buildworld http-token prints the file path, never the token value, and can provision it for an existing installation without changing the root password or restarting the server. Use the token in the Authorization: Bearer header through a protected secret or environment variable; never put it in URLs, pipeline parameters, logs or Git.

The token uses the existing root administrator and build:trigger scope. It does not grant system:update. Existing authorization and audit still apply; the value survives restarts. Revocation, owner deletion or demotion does not cause automatic reissue. Invalid files and symlinks are rejected without replacement. Serve remote automation over HTTPS or a trusted private network. The API remains authenticated, with the existing listener address and network exposure preserved.

Install a specific version or deploy offline
# macOS / Linux
sh install.sh 1.15.0
# Windows
.\install.ps1 -Version 1.15.0

For an air-gapped environment, publish the install scripts, platform bundle, and checksums.txt from release/vX.Y.Z/ to a trusted internal download host.

Pipeline as code

BuildWorld supports declarative TypeScript and YAML pipelines. The TypeScript editor provides validation and completion; pipeline code runs in a restricted sandbox without eval or new Function.

import { definePipeline, shell, stage } from '@buildworld/pipeline';

export default definePipeline({
  stages: [
    stage('Build', [shell('Compile', 'go build -o app ./cmd/server')]),
    stage('Test', [shell('Test', 'go test ./...')], { dependsOn: ['Build'] }),
  ],
});

Build dashboard

The React dashboard brings day-to-day CI/CD operations into one place:

  • Dashboard: project list, build status, queue, and recent builds.
  • Builds in Progress: inspect queued and running jobs and follow their live logs.
  • Build details: review artifacts, environment variables, and changesets.
  • Project configuration: manage pipeline definitions, triggers, and credentials.
  • Operations: access the audit log, build statistics, and monitoring views.

Plugins and integrations

BuildWorld includes plugins for common build tools and delivery systems. Available integrations include:

Category Examples
Build tools Go, Cargo, Gradle, Maven, npm, pip, .NET, Shell, PowerShell
Containers and deployment Docker, Kubernetes, Helm, Argo CD, Terraform, Ansible
Source control GitHub, GitLab, Gitea, SVN, Mercurial
Notifications Feishu (Lark), Slack, Discord, Telegram, Webhooks
Artifacts and security S3, Vault, SonarQube

Migrate from Jenkins

Move pipelines incrementally:

  1. Import a Jenkinsfile and generate a TypeScript pipeline.
  2. Run the same commit through Jenkins and BuildWorld during evaluation.
  3. Compare environment variables, artifacts, notifications, and deployment results.
  4. Switch triggers after the results meet your acceptance criteria.

Service operations

buildworld start
buildworld pause
buildworld resume
buildworld restart
buildworld status
buildworld enable-autostart
buildworld disable-autostart

Reset the administrator password without placing it in shell history:

printf '%s\n' 'new-strong-password' | buildworld reset-root-password --password-stdin

If an update fails, the previous bundle is retained in .previous for rollback.

Defaults and security

Setting Default
Web console and API http://127.0.0.1:8080
Initial administrator root / root — change after first login
Database SQLite at data/buildworld.db
Default executor Local builtin executor

For LAN access, bind server.host to a controlled network interface or use a reverse proxy with TLS. Never commit passwords, webhooks, tokens, or Git credentials.

Development and local release

# Go backend
go test ./...

# Web frontend
cd web && npm ci && npm test -- --run && npm run build

# Documentation site
cd docs-site && npm ci && npm run build
# Run the full local verification gate
.\scripts\verify-local.ps1

# Build bundles for Windows, Linux, and macOS (amd64 and arm64)
.\scripts\release-local.ps1 -Version 1.15.0

# Publish a NEW version after review and required production checks
.\scripts\publish-release-local.ps1 -Version X.Y.Z -Publish

Verification, builds, packaging, and release uploads run locally. This project does not use GitHub Actions for CI or publishing.

The local release publisher builds and publishes the English/Chinese HTML documentation after it creates and verifies a new vX.Y.Z release tag. Ordinary main pushes, staging tags, and replacement releases do not publish the site. Publishing guide.

Repository layout

buildworld/
├── cmd/          # CLI, server, and Worker entry points
├── internal/     # API, engine, storage, authentication, and plugins
├── web/          # React dashboard (Vite, TypeScript, Monaco)
├── plugins/      # Build, deployment, notification, and SCM integrations
├── proto/        # gRPC protocol definitions
├── sdk/          # Optional Worker SDK
├── scripts/      # Install, release, and verification scripts
├── docs-site/    # English and Simplified Chinese documentation
└── integration/  # Integration tests

Links

About

BuildWorld: a self-hosted CI/CD server and Jenkins alternative for build automation, pipelines, and deployments.

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages