Skip to main content

Crate ckm

Crate ckm 

Source
Expand description

CKM Core — the Single Source of Truth for all CKM language SDKs.

This crate contains ALL CKM algorithms: types, engine, migration, validation, and formatting. It has zero FFI concerns. Language wrappers (napi-rs, PyO3, CGo) depend on this crate.

§Quick Start

use ckm::CkmEngine;
use serde_json::json;

let data = json!({
    "$schema": "https://ckm.dev/schemas/v2.json",
    "version": "2.0.0",
    "meta": {
        "project": "my-tool",
        "language": "rust",
        "generator": "hand-authored",
        "generated": "2026-01-01T00:00:00.000Z"
    },
    "concepts": [],
    "operations": [],
    "constraints": [],
    "workflows": [],
    "configSchema": []
});

let engine = CkmEngine::new(data);
let index = engine.topic_index("my-tool");
println!("{}", index);

Re-exports§

pub use engine::CkmEngine;
pub use migrate::detect_version;
pub use migrate::migrate_v1_to_v2;
pub use types::CanonicalType;
pub use types::CkmConcept;
pub use types::CkmConfigEntry;
pub use types::CkmConstraint;
pub use types::CkmErrorResult;
pub use types::CkmInput;
pub use types::CkmInspectResult;
pub use types::CkmManifest;
pub use types::CkmMeta;
pub use types::CkmOperation;
pub use types::CkmOutput;
pub use types::CkmProperty;
pub use types::CkmTopic;
pub use types::CkmTopicIndex;
pub use types::CkmTopicIndexEntry;
pub use types::CkmTypeRef;
pub use types::CkmValidationError;
pub use types::CkmValidationResult;
pub use types::CkmWorkflow;
pub use types::CkmWorkflowStep;
pub use types::TopicJsonResult;
pub use validate::validate_manifest;
pub use builder::CkmManifestBuilder;

Modules§

builder
CKM Manifest Builder — fluent API for constructing valid ckm.json manifests.
engine
CKM engine — auto-generates topic index from a ckm.json manifest.
format
CKM terminal formatter — plain text output with no color dependencies.
migrate
CKM v1 to v2 migration and version detection.
types
CKM type definitions — Rust implementation of INTERFACE.md v2.0.0.
validate
CKM manifest validation against the v2 schema.