kweaver-core

Original：🇨🇳 Chinese

Translated

Interact with KWeaver Knowledge Network and Decision Agent — build knowledge networks, query Schema/instances, semantic search, execute Action, Agent CRUD and conversation, Trace data analysis. Interact with Dataflow document processes — list processes, trigger runs, query run history, view step logs. Interact with Skill management module — register Skill, search in market, progressive reading, download and installation. Interact with Toolbox / Tool — create toolbox, upload OpenAPI tools, publish, start and stop. Interact with Vega observability platform — query Catalog/resources/connector types, health inspection. This skill is automatically activated when users mention intents such as "knowledge network", "knowledge graph", "query object type", "execute Action", "what Agents are there", "create Agent", "converse with Agent", "list all Agent templates", "list Agents I created", "list Agents in private space", "dataflow", "data flow", "process orchestration", "process run records", "process logs", "trigger dataflow", "view dataflow run history", "Skill", "skill package", "register Skill", "install Skill", "read SKILL.md", "toolbox", "toolbox", "upload tool", "register tool", "OpenAPI tool", "enable tool", "publish toolbox", "data source", "data view", "atomic view", "Catalog", "Vega", "health check", "inspection", "trace", "evidence chain", "data flow tracking", "data source", "how data is obtained", etc.

3installs

Sourcekweaver-ai/kweaver-sdk

Added on2026-04-21

NPX Install

npx skill4agent add kweaver-ai/kweaver-sdk kweaver-core

SKILL.md Content (Chinese)

View Translation Comparison →

KWeaver CLI

Command-line tool for the KWeaver platform, covering authentication, platform business domain (

config

), knowledge network management and query, Agent CRUD and conversation, data source management.

Installation

bash

npm install -g @kweaver-ai/kweaver-sdk

Requires Node.js 22+. You can also run it temporarily with

npx kweaver

.

Usage

bash

kweaver [--user <userId|username>] <command> [subcommand] [options]

Complete subcommands and parameters are subject to the currently installed CLI: Run

kweaver --help

(or

-h

) to view the usage list synchronized with the code; check the version with

kweaver --version

/

-V

/

kweaver version

. For details of subcommands, use

kweaver <group> <subcommand> --help

(e.g.,

kweaver auth --help

,

kweaver bkn push --help

).

The

references/*.md

files under this skill align with CLI behaviors; tables and references are quick references, and new flags (such as

--alias

for

auth

, encoding options for BKN

validate

/

push

) are explained in the references.

Aliases:

kweaver curl

is equivalent to

kweaver call

;

kweaver context

is equivalent to

kweaver context-loader

.

Business domain: Most requests depend on

x-business-domain

. After

kweaver auth login

, you should first execute

kweaver config show

; if the list is empty, use

config list-bd

to view optional domains on the platform, then

config set-bd <uuid>

. See

references/config.md

for details.

Prerequisites

Authentication credentials are managed via
~/.kweaver/
. Default behavior: When a
refresh_token
exists, use OAuth2
refresh_token
authorization to obtain a new
access_token
(automatically executed when expired or nearly expired, no additional parameters required). Prohibited to check environment variables in advance, prohibited to ask users for passwords or Tokens.

Authentication Priority

```
KWEAVER_TOKEN
```
+
```
KWEAVER_BASE_URL
```
environment variables → Static Token (used preferentially if present, will not use refresh to obtain a new token)
Credentials in
```
~/.kweaver/
```
(written by
```
kweaver auth login
```
) → Default use refresh_token to obtain access_token (recommended)
```
KWEAVER_USER
```
environment variable (or global
```
--user
```
parameter) → Use credentials of the specified user, do not switch active users

Business Domain Priority (Independent of Authentication)

```
KWEAVER_BUSINESS_DOMAIN
```
environment variable

businessDomain

in the current platform's

config.json

(set via

kweaver config set-bd

)

Default
```
bd_public
```
(the CLI may have automatically written a more appropriate value after the first login)

Command Group Overview

Command Group	Description	Common Commands	Detailed Reference
`auth`	Authentication management (supports multiple accounts)	`auth login <url> [--alias name]` (shortened: `auth <url> [--alias …]` ); optional `--no-browser` , `-u/-p` for HTTP `/oauth2/signin` ; initial password (401001017) allows interactive password change in TTY, use `--new-password` in scripts; `auth change-password [<url>] [-u …]` (EACP password change; both URL and `-u` can be omitted, falling back to the current platform and current active account respectively; no token required); `auth list` / `auth users` / `auth switch` ; global `--user` / `KWEAVER_USER` ; when there is no current platform, `auth status` / `whoami` can use env as fallback (see `references/auth.md` )	`references/auth.md`
`token`	Print current access token (auto-refreshed)	`token`	—
`config`	Platform business domain (prioritized over most bkn/agent/ds operations)	`config show` , `config list-bd` , `config set-bd <uuid>`	`references/config.md`
`bkn`	BKN knowledge network management, Schema, query, Action	`bkn validate` / `push` detects `.bkn` encoding by default and normalizes it to UTF-8; use `--no-detect-encoding` or `--source-encoding gb18030` if needed; other commands include `pull` , `object-type` , `search` , `create-from-ds` / `create-from-csv` , etc., see `references/bkn.md`	`references/bkn.md`
`agent`	Agent CRUD, publish, conversation, Trace, templates, categories	`agent list` , `agent get <id>` , `agent create --name <n> --profile <p> --config <json>` , `agent publish <id> --category-id <cid>` , `agent chat <id> -m "..."` , `agent category-list` , `agent template-list` , `agent template-get <tpl_id>` , `agent sessions <agent_id>` , `agent history <conversation_id>` , `agent trace <conversation_id>`	`references/agent.md`
`ds`	Data source management	`ds list` , `ds get <id>` , `ds import-csv <ds_id> --files <glob> [--recreate]`	`references/ds.md`
`dataview`	Data view (mdl-data-model / vega-backend)	`dataview list` , `find --name` , `get` , `query` , `delete` ; BKN binding can also use `vega resource` ID (type=resource)	`references/dataview.md`
`dataflow`	Dataflow document processes	`dataflow list` , `dataflow run <dagId> --file <path>` , `dataflow run <dagId> --url <remote-url> --name <filename>` , `dataflow runs <dagId> [--since <date-like>]` , `dataflow logs <dagId> <instanceId> [--detail]`	`references/dataflow.md`
`skill`	Skill registration, market search, progressive reading, download and installation	`skill list` , `market` , `register --zip-file` , `content` , `read-file` , `install`	`references/skill.md`
`toolbox`	Platform toolbox management	`toolbox create --name <n> --service-url <url>` , `toolbox list` , `toolbox publish/unpublish <id>` , `toolbox delete <id> [-y]`	`references/toolbox.md`
`tool`	Tool registration, start and stop in toolbox (OpenAPI)	`tool upload --toolbox <id> <openapi-spec>` , `tool list --toolbox <id>` , `tool enable/disable --toolbox <id> <tool-id>...`	`references/tool.md`
`vega`	Vega observability platform	`vega health` , `vega catalog list` , `vega resource list` , `vega query execute -d <json>` , `vega sql --resource-type <t> --query "<sql>"` / `vega sql -d <json>`	`references/vega.md`
`context-loader`	MCP hierarchical retrieval	`context-loader config show` , `context-loader kn-search <query>`	`references/context-loader.md`
`call`	General API call	`call <url> [-X POST] [-d '...']` (can use `curl` alias; supports `--url` , `--data-raw` , etc., see `kweaver --help` )	`references/call.md`

Operation Guide

Scenario	Description	Detailed Reference
Confirm business domain after login	`config show` ; if abnormal or empty → `config list-bd` → `config set-bd <uuid>`	references/config.md
Build KN from database/CSV	Connect data source → Import CSV → Create KN → Build index → Query verification → Bind Agent	references/build-kn-from-db.md
CLI troubleshooting quick reference	Permissions, pull, build, import, dataview SQL, etc.	references/troubleshooting.md
List/query data views	`list` to browse; `find --name` to search by name ( `--exact` / `--wait` ); `query` to run SQL on views	references/dataview.md
Manage Dataflow document processes	`list` to view DAGs; `run` to trigger local files or remote URLs; `runs --since` to view daily run records; `logs --detail` to check step payloads	references/dataflow.md
Trace data analysis	`agent trace <conversation_id>` to obtain trace data and build evidence chain	—
Manage Skill	`list` / `market` to find Skills; `content` / `read-file` for progressive reading; `install` to download and extract for local use	references/skill.md
Register external tools	`toolbox create` to create a toolbox → `tool upload` to upload OpenAPI → `tool list` to get `tool_id` → `tool enable` to enable → `toolbox publish` to switch to published status	references/toolbox.md · references/tool.md

Read on demand: When you need complete parameters of subcommands or orchestration examples, read the corresponding reference files.

Call Examples

/kweaver-core List all knowledge networks
/kweaver-core Check Vega health status
/kweaver-core What Agents are there
/kweaver-core Converse with Agent xxx and ask "Today's inventory status"
/kweaver-core Search for content about "supply chain" in knowledge network xxx
/kweaver-core Use dataview find to fuzzy search data views whose names contain BOM
/kweaver-core List all dataflows
/kweaver-core Trigger dataflow 123 and upload local file ./demo.pdf
/kweaver-core View run records of dataflow 123 on 2026-04-01
/kweaver-core View logs of instance 456 of dataflow 123 and expand input output
/kweaver-core List all Agent templates
/kweaver-core Create a new Agent based on the "Data Analysis Assistant" template
/kweaver-core Search for skills containing kweaver in the skill market
/kweaver-core Read SKILL.md of skill xxx and save it to local directory
/kweaver-core Create a toolbox named weather-svc connected to https://weather.example.com
/kweaver-core Upload ./openapi.json to toolbox 1234567890, enable all tools, and finally publish

Notes

Do not guess business_domain values. When using for the first time, run
```
kweaver config show
```
or
```
kweaver config list-bd
```
to confirm the current business domain. If it returns
```
bd_public (default)
```
but the command result is empty, you may need to use
```
kweaver config set-bd <uuid>
```
to set the correct value (you can also list from the platform with
```
config list-bd
```
then
```
set-bd
```
, or get
```
X-Business-Domain
```
from the platform UI request header)
Action execution has side effects, confirm with users before execution
Prohibited to run
kweaver auth status
for pre-check. Execute the target command directly, and the CLI will automatically handle authentication and token refresh
Token expires in 1 hour. When a
```
refresh_token
```
exists in
```
~/.kweaver/
```
(obtained via OAuth2 login), the CLI will automatically refresh; when encountering a 401 error, the CLI will automatically attempt to refresh, and only prompt the user to re-run
```
kweaver auth login <url>
```
if the refresh fails

Query Strategy (object-type query)

When calling

object-type query

, you must limit

limit

, use

search_after

for pagination, and use

condition

for filtering to avoid wide table JSON truncation. Complete rules and examples can be found in

references/bkn.md

.