tokmd-core

High-level API facade for tokmd.

Overview

This is a Tier 4 crate providing the recommended entry point for library usage. It coordinates scanning, aggregation, and modeling to produce code inventory receipts.

Installation

[dependencies]
tokmd-core = "1.4"
tokmd-types = "1.4"

Usage

# fn main() -> Result<(), Box<dyn std::error::Error>> {
use tokmd_core::lang_workflow;
use tokmd_core::settings::{ScanSettings, LangSettings};

// Configure scan
let scan = ScanSettings::current_dir();
let lang = LangSettings {
    top: 10,
    files: true,
    ..Default::default()
};

// Run pipeline
let receipt = lang_workflow(&scan, &lang)?;
assert!(receipt.report.rows.len() > 0);
# Ok(())
# }

Main Function

pub fn lang_workflow(
    scan: &ScanSettings,
    lang: &LangSettings,
) -> Result<LangReceipt>

Chains: Scan -> Model -> Receipt

Redaction Modes

Re-exports

pub use tokmd_config as config;
pub use tokmd_types as types;

When to Use

• Library consumers wanting a simple scan API
• Embedding tokmd in other Rust tools
• Programmatic access without CLI overhead

License

MIT OR Apache-2.0