knowledge-base-cli 0.1.0

Command-line interface for a file-based knowledge base
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

# knowledge-base-cli

This crate provides the `knowledge-base` executable for validating, reading, querying, and updating a file-based knowledge base.

## Installation

Install the executable from crates.io:

```sh
cargo install knowledge-base-cli
```

Every executable command reads the knowledge-base root from `KNOWLEDGE_BASE_PATH`:

```sh
export KNOWLEDGE_BASE_PATH="/absolute/path/to/knowledge-base"
```

`--help` and `--version` do not require `KNOWLEDGE_BASE_PATH`.

## Commands

Validate the complete knowledge base:

```sh
knowledge-base validate
```

Read stored resources by their typed identifiers:

```sh
knowledge-base entity read Q1
knowledge-base entity-type read T1
knowledge-base property read P1
knowledge-base reference read R1
knowledge-base entity-context read Q1
```

Query entities using one or more typed property-value filters:

```sh
knowledge-base entity query --filter 'P3=Q2'
knowledge-base entity query --filter 'P3=Q2' --filter 'P1=228334'
knowledge-base entity query --filter 'P3=Q2' --limit 25 --offset 25
```

Multiple filters must all match. Results are deterministic YAML and default to 100 items from offset 0.

Inspect direct incoming, outgoing, and self-referential relationships:

```sh
knowledge-base entity relationships Q2
knowledge-base entity relationships Q2 --limit 25 --offset 25
```

Preview and apply a YAML statement manifest:

```sh
knowledge-base entity statement apply /tmp/statements.yaml --dry-run
knowledge-base entity statement apply /tmp/statements.yaml
```

An example manifest is:

```yaml
statements:
  - entity: Q1
    property: P1
    value: { type: integer, value: 123456789 }
    references: [R1]
```

The CLI assigns statement identifiers. Each item must contain `entity`, `property`, `value`, and at least one reference. A batch is applied completely or not at all.

## Output and exit status

Read commands write stored files to standard output exactly as written. Query and mutation commands produce deterministic YAML. Validation diagnostics and command errors are written to standard error.

Commands exit unsuccessfully when configuration is missing, input is invalid, a resource cannot be read, validation diagnostics are found, or a mutation cannot be applied.