MCPcopy Index your code
hub / github.com/jetkvm/kvm

github.com/jetkvm/kvm @main sqlite

repository ↗ · DeepWiki ↗
3,136 symbols 8,909 edges 371 files 659 documented · 21%
README
<img alt="JetKVM logo" src="https://jetkvm.com/logo-blue.png" height="28">

KVM

Discord | Website | Issues | Docs

Twitter

Go Report Card

JetKVM is a high-performance, open-source KVM over IP (Keyboard, Video, Mouse) solution designed for efficient remote management of computers, servers, and workstations. Whether you're dealing with boot failures, installing a new operating system, adjusting BIOS settings, or simply taking control of a machine from afar, JetKVM provides the tools to get it done effectively.

Features

  • Ultra-low Latency - 1080p@60FPS video with 30-60ms latency using H.264 encoding. Smooth mouse and keyboard interaction for responsive remote control.
  • Free & Optional Remote Access - Remote management via JetKVM Cloud using WebRTC.
  • Optional Tailscale Networking - Built-in Tailscale status and control-server configuration, including custom Headscale-compatible endpoints.
  • Open-source software - Written in Golang on Linux. Easily customizable through SSH access to the JetKVM device.

Contributing

We welcome contributions from the community! Whether it's improving the firmware, adding new features, or enhancing documentation, your input is valuable. We also have some rules and taboos here, so please read this page and our Code of Conduct carefully.

I need help

The best place to search for answers is our Documentation. If you can't find the answer there, check our Discord Server.

I want to report an issue

If you've found an issue and want to report it, please check our Issues page. Make sure the description contains information about the firmware version you're using, your platform, and a clear explanation of the steps to reproduce the issue.

Development

JetKVM is written in Go & TypeScript. with some bits and pieces written in C. An intermediate level of Go & TypeScript knowledge is recommended for comfortable programming.

The project contains two main parts, the backend software that runs on the KVM device and the frontend software that is served by the KVM device, and also the cloud.

For comprehensive development information, including setup, testing, debugging, and contribution guidelines, see DEVELOPMENT.md.

For quick device development, use the ./dev_deploy.sh script. It will build the frontend and backend and deploy them to the local KVM device. Run ./dev_deploy.sh --help for more information.

Backend

The backend is written in Go and is responsible for the KVM device management, the cloud API and the cloud web.

Frontend

The frontend is written in React and TypeScript and is served by the KVM device. It has three build targets: device, development and production. Development is used for development of the cloud version on your local machine, device is used for building the frontend for the KVM device and production is used for building the frontend for the cloud.

Extension points exported contracts — how you extend this code

HttpClient (Interface)
HttpClient is the interface for the HTTP client [6 implementers]
internal/ota/ota.go
NativeInterface (Interface)
NativeInterface defines the interface that both Native and NativeProxy implement [3 implementers]
internal/native/interface.go
DHCPClient (Interface)
DHCPClient is the interface for a DHCP client. [2 implementers]
internal/network/types/dhcp.go
Sink (Interface)
* ---------- SINK (terminal output) ---------- */ [1 implementers]
serial_console_helpers.go
StateChangeHandler (FuncType)
StateChangeHandler is the function type for link state callbacks
pkg/nmlite/link/manager.go
QuickButton (Interface)
============== Types ==============
ui/src/components/extensions/SerialConsole.tsx
HttpClientGetter (FuncType)
(no doc)
pkg/myip/ip.go
ApplyFunc (FuncType)
(no doc)
internal/usbgadget/changeset.go

Core symbols most depended-on inside this repo

Errorf
called by 519
internal/logging/pion.go
Info
called by 295
internal/logging/pion.go
Warn
called by 259
internal/logging/pion.go
Error
called by 256
internal/logging/pion.go
Lock
called by 205
internal/sync/mutex.go
Unlock
called by 201
internal/sync/mutex.go
callJsonRpc
called by 119
ui/e2e/helpers.ts
Interface
called by 105
pkg/nmlite/link/netlink.go

Shape

Method 1,401
Function 1,242
Struct 270
Interface 162
Class 26
TypeAlias 21
FuncType 14

Languages

Go75%
TypeScript25%
Python1%

Modules by API surface

internal/native/proto/native.pb.go373 symbols
internal/native/proto/native_grpc.pb.go181 symbols
jsonrpc.go91 symbols
ui/e2e/helpers.ts77 symbols
ui/src/hooks/hidRpc.ts64 symbols
internal/native/proxy.go56 symbols
pkg/nmlite/interface.go46 symbols
ui/e2e/remote-agent/remote-agent.ts45 symbols
serial_console_helpers.go42 symbols
internal/native/cgo_linux.go39 symbols
ui/src/hooks/stores.ts38 symbols
usb_mass_storage.go36 symbols

Dependencies from manifests, versioned

github.com/Masterminds/semver/v3v3.4.0 · 1×
github.com/ProtonMail/go-cryptov1.1.5 · 1×
github.com/beevik/ntpv1.5.0 · 1×
github.com/beorn7/perksv1.0.1 · 1×
github.com/cespare/xxhash/v2v2.3.0 · 1×
github.com/cloudflare/circlv1.3.7 · 1×
github.com/cloudwego/base64xv0.1.6 · 1×

For agents

$ claude mcp add kvm \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact