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::scan_workflow;
use tokmd_core::config::GlobalArgs;
use tokmd_core::types::{ChildrenMode, LangArgs, RedactMode, TableFormat};
use std::path::PathBuf;

// Configure scan
let global = GlobalArgs::default();
let lang = LangArgs {
    paths: vec![PathBuf::from(".")],
    format: TableFormat::Json,
    top: 10,
    files: false,
    children: ChildrenMode::Collapse,
};

// Run pipeline (without redaction)
let receipt = scan_workflow(&global, &lang, None)?;
println!("Scanned {} languages", receipt.report.rows.len());

// Run pipeline (with path redaction)
let redacted = scan_workflow(&global, &lang, Some(RedactMode::Paths))?;
# Ok(())
# }

Main Function

pub fn scan_workflow(
    global: &GlobalArgs,
    lang: &LangArgs,
    redact: Option<RedactMode>,
) -> 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