Getting started with Ze.

Run the two-peer BGP lab by hand, or ask Claude Code or Codex to run it with Ze’s bundled skill. Both paths start on a Linux lab host with Go and Git.

By hand

# build from source
$ git clone https://github.com/ze-software/ze.git
$ cd ze && ./ze version

# copy the supplied local lab configuration
$ mkdir -p lab/r1 lab/r2
$ cp examples/quickstart/r1.conf lab/r1/ze.conf
$ cp examples/quickstart/r2.conf lab/r2/ze.conf

# one peer in each terminal
$ ./ze start lab/r1/ze.conf
$ ./ze start lab/r2/ze.conf

# inspect received routes from a third terminal
$ ZE_SSH_PASSWORD=lab ./ze cli --remote 127.0.0.1:2221 --user lab -c "show bgp rib | received"

With AI

# build from source
$ git clone https://github.com/ze-software/ze.git
$ cd ze && ./ze version

# make ze available to your agent
$ export PATH="$PWD:$PATH"
$ ze create agent skill
$ ze show agent skill

# start Claude Code or Codex from this shell
# in Codex, trust Ze's hook with /hooks
Then ask your agent
Use the ze skill and docs/guide/quickstart.md
to run the local two-peer lab.

Validate both configurations, start both peers,
and verify that the session is established.
Check that r1 receives 198.51.100.0/24 and
r2 receives 192.0.2.0/24. Show me the results.

Stop only the lab processes you started.
Keep the logs if a check fails.

Why Ze?

Ze brings BGP, Linux interfaces and forwarding-table management together with network services and plugins in one open-source platform. Use the same configuration model and tools in a lab, as a daemon or as an appliance, with routing policy data, reference pages generated from the code and test results available alongside them.

Manage Ze directly.

Ze runs its own SSH server, CLI and configuration editor. Connect directly to configure and operate it, without a host SSH service or shell. The web interface, REST, gRPC, gNMI and MCP expose the same YANG-modeled configuration.

Ze SSH + CLIWebAPIs + MCP
YANG-modeled configuration Routing · Interfaces · Network services

From connection to configuration

Change a setting through Ze’s SSH editor, review the diff, commit it and check the result.

  1. Connect
  2. Edit
  3. Review
  4. Commit

Playback starts at the SSH introduction (0:36) in the full recorded session. Use full screen for a closer look.

ExaBGP

ExaBGP on steroids

Used as a controller, Ze behaves like ExaBGP: your scripts run unchanged and the host's routing table is left alone. Its native API offers much more: a program written in any language can filter each route (accept, reject or rewrite it), add its own commands and YANG configuration, and report problems through ze doctor.

Peering

Made for operators

Give Ze a peer's ASN and it finds the AS-SET in PeeringDB, builds the IRR prefix filter and keeps it up to date, so no bgpq4 job is needed. RPKI validation and a looking glass with a Birdwatcher-compatible API are built in, and the CLI completes every command and explains what is wrong.

Deployment

Run it the way you want

One binary, four ways to run it: a daemon on the Linux host you already have, a dedicated appliance image for a VM or mini PC, a Docker container, or a node in a containerlab topology. The configuration and the commands stay the same.

AI

Made for AI assistants

Connect an assistant to Ze's MCP server and describe the symptom. It runs ze doctor, reads peer, route and interface state from the live daemon, and explains the cause, using a reference built from that binary.

Evidence for your decision

Tests that catch bugs

Go tests, complete operator scenarios, generated inputs and exchanges with other implementations cover different kinds of failure. These figures show the inventory and the evidence behind it.

By use case

Start with the role you have in mind.

Inspect the requirements and remaining gaps for your network role, alongside the feature maturity information.

Standards requirements

Mandatory RFC requirements proven

44.9%

2,136 of 4,752 requirements for Ze or the OS.

196RFCs implemented
0unreviewed requirement lists excluded

Each test identifies the requirement it checks. The ledger names the evidence and missing coverage.

Counting history

Until 2026-10-31: all mandatory rows counted, including annotated rows; summary rows excluded.

Standards requirements and test results →
Tests with other implementations

Interoperability scenarios

399

BGP sessions, routes, policy and recovery, alongside routing, VPN, access and multi-node cases.

8lab suites
13test images listed
BIRDFRRGoBGPOpenBGPD freeRouterRustyBGPrustbgpdStayRTR keepaliveddnsmasqKeaKnot DNSUnbound

These test images are reused across many scenarios. Other labs and tools use additional images, including pmacct.

A scenario can contain many checks, and many scenarios reuse the same peer implementation. These counts describe the inventory, not current passing runs or individual assertions.

Docker scenarios and peer checks →
The scenarios behind the figure

Where the 399 scenarios are defined.

Explore the BGP lab →
Scenario inventory across 8 lab suites. The shared suite is split by primary protocol; the two RADIUS suites are combined.
Protocol or test areaScenariosWhat the cases cover
BGP142Route exchange, path attributes, graceful restart, route reflection, route-server and session cases.
OSPFv236Adjacencies, authentication, areas, LSAs, route policy and recovery.
OSPFv320IPv6 adjacencies, address families, IPv4 over OSPFv3, IPsec protection and recovery.
IS-IS16Adjacencies, authentication, levels, metrics, route policy and convergence.
BFD5Sessions, link-local peers and simple-password authentication.
BMP4Route monitoring, local-RIB export, receivers and statistics.
RPKI / RTR3Route-origin validation and validator-cache sessions and preference.
VRRP2Mastership and VRRPv2 address-owner cases.
DNS2Resolver forwarding and DNS service for DHCP clients.
DHCPv43Renewal, rebinding, NAK handling and shared-segment server cases.
DHCPv62Client confirmation and renewal against Kea.
LDP3Session backoff, unknown TLVs and keepalive expiry.
AS1126Anycast route announcements, communities, origin attributes and redistribution.
GTSM1TTL protection for ICMP errors related to a protected BGP session.
IPsec85Tunnel negotiation, authentication and recovery scenarios.
L2TP13Access tunnels, sessions and PPP cases.
PPPoE16Client and access-session scenarios.
RADIUS12Operator login, authorization, subscriber accounting, CoA and disconnect cases.
RSVP-TE10Transit, label and signaling scenarios.
Multi-node topologies18Links, routes and service interactions between nodes.
All scenarios399Each scenario counts toward one category only. If it tests several protocols, we group it only under the main one it tests.
Package behavior

Go tests

45,600+

Check encoded bytes and parsed values. Verify configuration, state transitions and plugins. Mutation checks with gomu examine whether tests catch code changes.

Go tests and mutation checks →
Visible behavior

End-to-end tests

2,900+

Start sessions and exchange route updates. Run editor commands, commits and reloads. Check output, errors and saved state.

Scenarios and expected results →
Generated inputs

Fuzz targets

100+

Generate inputs for parsers and decoders. Probe packets and configuration text for crashes. Replay saved failures as regression cases.

Fuzz inputs and regression cases →

Ze is written with AI agents working under a quality process based on ISO management systems. How Ze is developed with AI explains the process.

Capabilities and current limitations.

Feature pages explain behavior and limits. The maturity record separates available code from the evidence still needed before a feature can be recommended for production.

The configuration and command references come from the definitions used by Ze itself. When those definitions change, the next website build updates the reference, including settings supplied by plugins.

Explore features by category

Choose how to try Ze.

A local BGP lab is the simplest starting point. If you already run ExaBGP or want a different deployment, follow the path that matches your setup.

ExaBGP migration

Try an existing configuration.

Convert an ExaBGP configuration, review the result, and use the compatibility bridge for process scripts. The guide explains the limits and cutover checks.

Success checkValidate the converted configuration and verify your sessions and script behavior in a lab.

Explore migration
Linux or Docker

Keep your existing host.

Install the Linux service or build the Docker deployment image with persistent storage. The guides cover authenticated management, updates and removal; the Linux host keeps its existing interface configuration.

Success checkConnect to authenticated management and check that your configuration survives the documented restart or container recreation.

VM or appliance

Give Ze its own system.

Build an immutable gokrazy system for QEMU, Proxmox or hardware, with a read-only root and persistent configuration. The guide covers ISO installation, authenticated SSH, updates and previous-slot recovery.

AvailabilitySource builds produce disk images and installer ISOs. No public image release is available yet.

Explore the appliance

The quickstart builds from source and needs Go and Git. It checks the BGP control plane; receiving routes does not establish forwarding connectivity. For a live topology that also checks kernel routes and traffic, use the netlab guide.

Recent engineering notes.

The update reports describe changes recorded in git and shared in Discord's ze-news channel.