sqz_engine/
lib.rs

1//! # sqz_engine
2//!
3//! The core compression engine behind sqz. Takes text — JSON, CLI output, code,
4//! logs, prose — and squeezes it down to use fewer LLM tokens while keeping the
5//! important stuff intact.
6//!
7//! ## Quick start
8//!
9//! ```rust
10//! use sqz_engine::SqzEngine;
11//!
12//! let engine = SqzEngine::new().expect("failed to init engine");
13//!
14//! // Compress some text
15//! let result = engine.compress("hello world").unwrap();
16//! println!("compressed: {}", result.data);
17//! println!("tokens: {} → {}", result.tokens_original, result.tokens_compressed);
18//!
19//! // JSON gets TOON-encoded automatically
20//! let json_result = engine.compress(r#"{"name": "Alice", "age": 30}"#).unwrap();
21//! assert!(json_result.data.starts_with("TOON:"));
22//! ```
23//!
24//! ## How it works
25//!
26//! Content flows through a multi-stage pipeline:
27//!
28//! 1. **Content routing** — the confidence router classifies input (JSON, code,
29//!    logs, prose) and picks a compression mode (safe, default, aggressive).
30//! 2. **Stage pipeline** — configurable stages run in priority order: ANSI
31//!    stripping, null removal, repeated-line condensing, git diff folding,
32//!    string truncation, array collapsing, and custom transforms.
33//! 3. **Post-processing** — RLE compression, sliding-window dedup, entropy
34//!    truncation, and token pruning for prose.
35//! 4. **TOON encoding** — JSON gets encoded into Token-Optimized Object
36//!    Notation, which drops unnecessary quotes and whitespace for 30-60%
37//!    fewer tokens.
38//! 5. **Verification** — a two-pass verifier checks that error lines, JSON
39//!    keys, and diff hunks survived compression. If confidence is low, the
40//!    engine falls back to safe mode.
41//!
42//! ## Key types
43//!
44//! - [`SqzEngine`] — top-level facade, wires everything together
45//! - [`CompressionPipeline`] — the stage-based compression orchestrator
46//! - [`CacheManager`] — SHA-256 content-hash dedup cache
47//! - [`SessionStore`] — SQLite-backed session and cache persistence
48//! - [`Preset`] — TOML-configurable compression settings
49//! - [`ToonEncoder`] — JSON → TOON lossless encoding
50//! - [`CompressedContent`] — compression result with token counts and metadata
51
52pub mod adaptive_tree;
53pub mod advanced_search;
54pub mod ansi_strip;
55pub mod api_proxy;
56pub mod ast_delta;
57pub mod ast_parser;
58pub mod benchmarks;
59#[cfg(test)]
60mod cmd_formatter_bench;
61pub mod bpe_compressor;
62pub mod cascade_compressor;
63pub mod claude_md_integration;
64pub mod cmd_formatters;
65pub mod codex_integration;
66pub mod compression_quality;
67pub mod confidence_router;
68pub mod context_evictor;
69pub mod crp_engine;
70pub mod dashboard;
71pub mod delta_encoder;
72pub mod dependency_mapper;
73pub mod dict_compressor;
74pub mod entropy_analyzer;
75pub mod entropy_truncator;
76pub mod file_reader;
77pub mod image_compressor;
78pub mod json_projection;
79pub mod kv_cache_optimizer;
80pub mod litm_positioner;
81pub mod mdl_selector;
82pub mod minhash_lsh;
83pub mod ngram_abbreviator;
84pub mod opencode_plugin;
85pub mod rle_compressor;
86pub mod simhash;
87pub mod textrank;
88pub mod token_pruner;
89pub mod tool_hooks;
90pub mod tool_selector;
91pub mod engine;
92pub mod hook_manager;
93pub mod budget_tracker;
94pub mod cache_manager;
95pub mod correction_log;
96pub mod cost_calculator;
97pub mod ctx_format;
98pub mod error;
99pub mod model_router;
100pub mod parse_tree_compressor;
101pub mod pipeline;
102pub mod pin_manager;
103pub mod plugin_api;
104pub mod preset;
105pub mod progressive_throttle;
106pub mod prompt_cache;
107pub mod regret_tracker;
108pub mod sandbox_executor;
109pub mod session_continuity;
110pub mod session_store;
111pub mod stages;
112pub mod structural_summary;
113pub mod tee_mode;
114pub mod terse_mode;
115pub mod token_counter;
116pub mod toon;
117pub mod transparency;
118pub mod types;
119pub mod url_indexer;
120pub mod verifier;
121
122pub use advanced_search::{AdvancedSearch, SearchResult};
123pub use ansi_strip::AnsiStripper;
124pub use api_proxy::{compress_request, parse_http_request, build_http_response, ApiFormat, ProxyConfig, ProxyStats};
125pub use ast_parser::{AstParser, ClassDefinition, CodeSummary, FunctionSignature, ImportDecl, TypeDeclaration};
126pub use bpe_compressor::{bpe_compress, BpeConfig, BpeResult};
127pub use compression_quality::{measure_quality, format_quality_report, CompressionQuality, QualityGrade};
128pub use confidence_router::{ConfidenceRouter, CompressionMode};
129pub use context_evictor::{evict, should_evict, ContextItem, EvictionConfig, EvictionResult};
130pub use cmd_formatters::format_command;
131pub use delta_encoder::{DeltaConfig, DeltaEncoder, DeltaResult};
132pub use dependency_mapper::DependencyMapper;
133pub use dict_compressor::{DictCompressor, DictConfig, DictCompressResult};
134pub use entropy_analyzer::{EntropyAnalyzer, InfoLevel, AnalyzedBlock};
135pub use entropy_truncator::{EntropyTruncator, EntropyTruncConfig, EntropyTruncResult, EntropyTruncArrayResult};
136pub use file_reader::{FileReadMode, FileReader, ReadResult, BlockEntropy, compute_entropy, analyze_block_entropies};
137pub use image_compressor::{ImageCompressor, ImageDescription};
138pub use json_projection::{project_json, ProjectionConfig, ProjectionResult};
139pub use litm_positioner::{ContextSection, LitmPositioner, LitmStrategy, SectionType};
140pub use ngram_abbreviator::{NgramAbbreviator, AbbreviatorConfig, AbbreviationResult};
141pub use rle_compressor::{rle_compress, sliding_window_dedup, RleResult, SlidingWindowResult};
142pub use simhash::{simhash, SimHashFingerprint};
143pub use structural_summary::{summarize as structural_summarize, summarize_multi, SummaryConfig, StructuralSummaryResult};
144pub use textrank::{textrank_compress, TextRankConfig, TextRankResult};
145pub use mdl_selector::{select_stages, profile_content, ContentProfile, MdlSelection};
146pub use tool_hooks::{process_hook, process_hook_cursor, process_hook_gemini, process_hook_kiro, process_hook_windsurf, generate_hook_configs, install_tool_hooks, install_tool_hooks_scoped, install_tool_hooks_scoped_filtered, claude_user_settings_path, remove_claude_global_hook, canonicalize_tool_name, parse_tool_list, InstallScope, ToolFilter, ToolHookConfig, HookScope, HookPlatform, SUPPORTED_TOOL_NAMES};
147pub use opencode_plugin::{
148    generate_opencode_plugin, install_opencode_plugin, update_opencode_config,
149    update_opencode_config_detailed, find_opencode_config,
150    opencode_config_has_comments,
151    plan_opencode_config_change, PlannedOpencodeChange,
152    remove_sqz_from_opencode_config, strip_jsonc_comments,
153    process_opencode_hook, opencode_plugin_path,
154};
155pub use codex_integration::{
156    agents_md_guidance_block, agents_md_path,
157    codex_config_path,
158    install_agents_md_guidance, install_codex_mcp_config,
159    remove_agents_md_guidance, remove_codex_mcp_config,
160};
161pub use claude_md_integration::{
162    claude_md_guidance_block, claude_md_path, claude_user_json_path,
163    install_claude_md_guidance, install_claude_mcp_config,
164    remove_claude_md_guidance, remove_claude_mcp_config,
165};
166pub use token_pruner::{TokenPruner, PrunerConfig, PruneResult};
167pub use tool_selector::{ToolDefinition, ToolSelector};
168pub use budget_tracker::{
169    AgentBudget, BudgetTracker, BudgetWarning, UsagePrediction, UsageReport,
170};
171pub use cache_manager::{CacheManager, CacheResult, ExpandResult};
172pub use correction_log::ContextWindow;
173pub use crp_engine::{CrpEngine, CrpLevel};
174pub use cost_calculator::{
175    CostBreakdown, CostCalculator, ModelPricing, PricingConfig, SessionCostSummary, TokenUsage,
176    ToolCost,
177};
178pub use ctx_format::{CtxEnvelope, CtxFormat, CtxMetadata};
179pub use error::{Result, SqzError, SourceLocation};
180pub use model_router::{ModelRouter, RoutingDecision, TaskContext};
181pub use pipeline::{CompressionPipeline, SessionContext};
182pub use pin_manager::PinManager;
183pub use plugin_api::{PluginLoader, PluginManifest, PluginSource, SqzPlugin};
184pub use prompt_cache::{CacheBoundary, Message, PromptCacheDetector};
185pub use session_store::{CommandStats, CompressionStats, DailyGain, SessionStore, SessionSummary};
186pub use session_continuity::{
187    SessionContinuityManager, SessionGuide, Snapshot, SnapshotEvent, SnapshotEventType,
188};
189pub use toon::ToonEncoder;
190pub use tee_mode::{TeeMode, TeeManager, TeeEntry};
191pub use terse_mode::TerseMode;
192pub use token_counter::TokenCounter;
193pub use types::*;
194pub use preset::{
195    BudgetConfig, CollapseArraysConfig, CompressionConfig, CondenseConfig, CustomTransformsConfig,
196    FlattenConfig, GitDiffFoldConfig, KeepFieldsConfig, ModelConfig, ModelPricingConfig, Preset,
197    PresetHeader, PresetMeta, PresetParser, StripFieldsConfig, StripNullsConfig, TerseLevel,
198    TerseModeConfig, ToolSelectionConfig, TruncateStringsConfig,
199};
200pub use progressive_throttle::{ProgressiveThrottler, ThrottleConfig, ThrottleLevel};
201pub use dashboard::{
202    CommandBreakdown, DashboardConfig, DashboardHtml, DashboardMetrics, DashboardServer,
203    SessionHistoryEntry, ToolBreakdown,
204};
205pub use engine::SqzEngine;
206pub use hook_manager::{
207    generate_platform_config, known_platforms, Hook, HookAction, HookContext, HookManager, HookType,
208};
209pub use sandbox_executor::{SandboxExecutor, SandboxResult, RuntimeInfo, FilteredOutput};
210pub use url_indexer::{ContentFetcher, IndexedChunk, IndexResult, UrlIndexer};
211pub use verifier::Verifier;
212
213pub use adaptive_tree::{compress_to_budget, build_tree, SemanticNode};
214pub use ast_delta::{ast_diff, encode_delta, AstDelta, AstChange, ChangeKind};
215pub use kv_cache_optimizer::{compress_with_sinks, compress_with_custom_sinks};
216pub use minhash_lsh::{MinHashLsh, MinHashSignature};
217pub use parse_tree_compressor::{compress_code, char_entropy};
218pub use cascade_compressor::{cascade_compress, CascadeLevel, CascadeThresholds, CascadeResult};
219pub use regret_tracker::{RegretTracker, RegretEvent, RegretKind, FileProfile};
220pub use transparency::{CompressionAnnotation};
sqz_engine/lib.rs

sqz_engine/
lib.rs
