okf 0.2.6

The Open Knowledge Format (OKF) v0.2 in pure Rust: the `okf` CLI (validate, lint, inspect, index, graph, format, diff) plus the full okf-core and okf-validator library APIs re-exported.
Documentation 
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214

use std::process::Command;

fn okf_bin() -> &'static str {
    env!("CARGO_BIN_EXE_okf")
}

#[test]
fn cli_validate_flags_code_block_syntax_warning_in_bundle() {
    let temp_dir = std::env::temp_dir().join(format!("okf_val_code_err_{}", std::process::id()));
    let _ = std::fs::remove_dir_all(&temp_dir);
    std::fs::create_dir_all(&temp_dir).unwrap();

    let comp_md = r#"---
type: Attested Computation
title: Bad Calc
description: Calculation with syntax error
generated: { by: agent/test, at: 2026-06-20T22:53:05Z }
verified: { by: human:walter, at: 2026-06-25T09:00:00Z }
runtime: python
parameters:
  - { name: x, type: integer }
executor:
  name: runner
  resource: run.sh
  receipt: [run.log]
attester:
  name: checker
  resource: verify.py
---

# Bad Calc

Calculation description.

# Computation

```python
def broken_calc(
```
"#;

    std::fs::write(temp_dir.join("bad_calc.md"), comp_md).unwrap();
    std::fs::write(temp_dir.join("run.sh"), "echo run\n").unwrap();
    std::fs::write(temp_dir.join("verify.py"), "def check(): pass\n").unwrap();
    std::fs::write(
        temp_dir.join("index.md"),
        "# Index\n\n* [Bad Calc](bad_calc.md)\n",
    )
    .unwrap();

    let output = Command::new(okf_bin())
        .arg("validate")
        .arg(&temp_dir)
        .output()
        .unwrap();

    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(
        stdout.contains("[warning]"),
        "stdout should have warning: {stdout}"
    );
    assert!(
        stdout.contains("syntax check failed"),
        "stdout should mention syntax failure: {stdout}"
    );
    // Warnings do not fail conformance
    assert_eq!(output.status.code(), Some(0));

    let _ = std::fs::remove_dir_all(&temp_dir);
}

#[test]
fn cli_validate_flags_computation_script_syntax_warning_in_bundle() {
    let temp_dir = std::env::temp_dir().join(format!("okf_val_script_err_{}", std::process::id()));
    let _ = std::fs::remove_dir_all(&temp_dir);
    std::fs::create_dir_all(&temp_dir).unwrap();

    let comp_md = r#"---
type: Attested Computation
title: External Script Calc
description: Calculation with external script syntax error
generated: { by: agent/test, at: 2026-06-20T22:53:05Z }
verified: { by: human:walter, at: 2026-06-25T09:00:00Z }
computation: calc.py
runtime: python
executor:
  name: runner
  resource: executor.sh
  receipt: [run.log]
attester:
  name: checker
  resource: attester.py
---

# External Script Calc

Calculation description.
"#;

    std::fs::write(temp_dir.join("calc.md"), comp_md).unwrap();
    std::fs::write(temp_dir.join("calc.py"), "def broken_code(\n").unwrap();
    std::fs::write(temp_dir.join("executor.sh"), "echo run\n").unwrap();
    std::fs::write(temp_dir.join("attester.py"), "def verify(): pass\n").unwrap();
    std::fs::write(
        temp_dir.join("index.md"),
        "# Index\n\n* [External Script Calc](calc.md)\n",
    )
    .unwrap();

    let output = Command::new(okf_bin())
        .arg("validate")
        .arg(&temp_dir)
        .output()
        .unwrap();

    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(
        stdout.contains("[warning]"),
        "stdout should have warning: {stdout}"
    );
    assert!(
        stdout.contains("syntax check failed"),
        "stdout should mention syntax failure: {stdout}"
    );
    // Warnings do not fail conformance
    assert_eq!(output.status.code(), Some(0));

    let _ = std::fs::remove_dir_all(&temp_dir);
}

#[test]
fn cli_trust_and_links_handle_broken_pipe_cleanly() {
    let temp_dir = std::env::temp_dir().join(format!("okf_pipe_test_{}", std::process::id()));
    let _ = std::fs::remove_dir_all(&temp_dir);
    std::fs::create_dir_all(&temp_dir).unwrap();

    let init_status = Command::new(okf_bin())
        .args(["init", temp_dir.to_str().unwrap()])
        .status()
        .unwrap();
    assert!(init_status.success());

    // Populate enough concepts to generate output larger than the pipe buffer
    for i in 0..400 {
        let content = format!(
            "---\ntype: Metric\ntitle: Metric {i} with a very long title and lots of extra description\ndescription: Extensive description for metric {i} to fill pipe buffer\nstatus: stable\n---\n\n# Metric {i}\nBody text.\n"
        );
        std::fs::write(temp_dir.join(format!("metric_{i}.md")), content).unwrap();
    }

    // 1. Test okf trust piped
    {
        let mut child = Command::new(okf_bin())
            .args(["trust", temp_dir.to_str().unwrap()])
            .stdout(std::process::Stdio::piped())
            .stderr(std::process::Stdio::piped())
            .spawn()
            .unwrap();

        {
            use std::io::BufRead;
            let stdout = child.stdout.take().unwrap();
            let mut reader = std::io::BufReader::new(stdout);
            let mut line = String::new();
            let _ = reader.read_line(&mut line);
            // Drop reader to close the read end of the pipe
        }

        let output = child.wait_with_output().unwrap();
        assert_eq!(output.status.code(), Some(0));
        let stderr = String::from_utf8_lossy(&output.stderr);
        assert!(
            !stderr.contains("panicked"),
            "trust stderr had panic: {stderr}"
        );
        assert!(
            !stderr.contains("Broken pipe"),
            "trust stderr had broken pipe: {stderr}"
        );
    }

    // 2. Test okf links piped
    {
        let mut child = Command::new(okf_bin())
            .args(["links", temp_dir.to_str().unwrap()])
            .stdout(std::process::Stdio::piped())
            .stderr(std::process::Stdio::piped())
            .spawn()
            .unwrap();

        {
            use std::io::BufRead;
            let stdout = child.stdout.take().unwrap();
            let mut reader = std::io::BufReader::new(stdout);
            let mut line = String::new();
            let _ = reader.read_line(&mut line);
            // Drop reader to close the read end of the pipe
        }

        let output = child.wait_with_output().unwrap();
        assert_eq!(output.status.code(), Some(0));
        let stderr = String::from_utf8_lossy(&output.stderr);
        assert!(
            !stderr.contains("panicked"),
            "links stderr had panic: {stderr}"
        );
        assert!(
            !stderr.contains("Broken pipe"),
            "links stderr had broken pipe: {stderr}"
        );
    }

    let _ = std::fs::remove_dir_all(&temp_dir);
}