Skip to content

kweaver-ai/bkn-specification

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

100 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BKN Specification

Build

BKN (Business Knowledge Network) is a Markdown-based domain modeling language for business knowledge networks. This repository hosts the official specification and examples.

中文

Specification

The core documentation is the BKN Language Specification:

SDK

Official SDKs for parsing, validating, and transforming BKN files. See sdk/ for full documentation.

Language Package Install
Python PyPI pip install kweaver-bkn
TypeScript npm npm install @kweaver-ai/bkn
Golang go get github.com/kweaver-ai/bkn-specification/sdk/golang

CLI

The repository also includes a Go-based CLI for inspecting, validating, and transforming BKN files:

Key Concepts

Concept Description
Object Business object types (e.g. Pod, Node, Service)
Relation Links between objects
Action Operations on objects (with tool/MCP binding)
Risk Risk type for structured execution risk modeling
data_view Data source mapping for objects and relations

Updating Networks (No-Patch Model)

  • Add/modify: Edit .bkn files and import (upsert by network, type, id).
  • Delete: Use the SDK/CLI delete API explicitly; deletion is not expressed in BKN files.

File Organization

├── docs/
│   ├── SPECIFICATION.md      # Full spec (CN)
│   ├── SPECIFICATION.en.md   # Full spec (EN)
│   ├── ARCHITECTURE.md       # Architecture overview
│   └── templates/            # BKN file templates
└── examples/                 # Example networks (Kubernetes topology)
    ├── k8s-topology.bkn      # Single-file example
    ├── k8s-network/          # Split by type (objects, relations, actions)
    └── k8s-modular/          # One definition per file

License

Apache-2.0

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors