kaish_kernel/
lib.rs

1//! kaish-kernel (核): The core of 会sh.
2//!
3//! This crate provides:
4//!
5//! - **Lexer**: Tokenizes kaish source code using logos
6//! - **Parser**: Builds AST from tokens using chumsky
7//! - **AST**: Type definitions for the abstract syntax tree
8//! - **Interpreter**: Expression evaluation, scopes, and the `$?` result type
9//! - **VFS**: Virtual filesystem with mount points
10//! - **Tools**: Tool trait, registry, and builtin commands
11//! - **Scheduler**: Pipeline execution and background job management
12//! - **Paths**: XDG-compliant path helpers
13
14pub mod arithmetic;
15pub mod ast;
16pub mod backend;
17pub(crate) mod backend_walker_fs;
18pub mod dispatch;
19pub mod duration;
20pub mod help;
21pub mod ignore_config;
22pub mod interpreter;
23pub mod output_limit;
24pub mod kernel;
25pub mod lexer;
26pub mod nonce;
27pub mod parser;
28pub mod paths;
29#[cfg(all(unix, feature = "subprocess"))]
30pub mod pidfd;
31pub mod scheduler;
32pub(crate) mod telemetry;
33pub mod tools;
34pub mod trash;
35#[cfg(feature = "os-integration")]
36pub mod trash_system;
37pub mod validator;
38pub mod vfs;
39#[cfg(all(unix, feature = "subprocess"))]
40pub mod terminal;
41
42// Re-export kaish_glob as our glob/walker modules for backwards compatibility
43pub use kaish_glob as glob_crate;
44
45/// Glob pattern matching (re-exported from kaish-glob).
46pub mod glob {
47    pub use kaish_glob::glob::{contains_glob, expand_braces, glob_match};
48}
49
50/// Recursive file walking infrastructure (re-exported from kaish-glob).
51pub mod walker {
52    pub use kaish_glob::{
53        EntryTypes, FileWalker, FilterResult, GlobPath, IgnoreFilter, IncludeExclude,
54        PathSegment, PatternError, WalkOptions, WalkerDirEntry, WalkerError, WalkerFs,
55    };
56    pub use crate::backend_walker_fs::BackendWalkerFs;
57}
58
59pub use backend::{
60    BackendError, BackendResult, KernelBackend, LocalBackend, PatchOp, ReadRange,
61    ToolInfo, ToolResult, VirtualOverlayBackend, WriteMode,
62};
63pub use dispatch::{CommandDispatcher, PipelinePosition};
64pub use ignore_config::{IgnoreConfig, IgnoreScope};
65pub use kernel::{ExecuteOptions, Kernel, KernelConfig, VfsMountMode};
66pub use output_limit::OutputLimitConfig;
67
68// ═══════════════════════════════════════════════════════════════════════════
69// Embedding Conveniences
70// ═══════════════════════════════════════════════════════════════════════════
71
72// Backend with /v/* support for embedders
73//
74// Use `Kernel::with_backend()` to provide a custom backend with automatic
75// `/v/*` path support (job observability, blob storage):
76//
77// ```ignore
78// let kernel = Kernel::with_backend(my_backend, config, |vfs| {
79//     vfs.mount_arc("/v/docs", docs_fs);
80// }, |_| {})?;
81// ```
82
83// Git types (for embedders that want direct GitVfs access)
84#[cfg(feature = "git")]
85pub use vfs::{FileStatus, GitVfs, LogEntry, StatusSummary, WorktreeInfo};
86
87// Job observability (for embedders capturing command output)
88pub use scheduler::{BoundedStream, StreamStats, DEFAULT_STREAM_MAX_SIZE, drain_to_stream};
89pub use vfs::JobFs;
90
91// XDG path primitives (embedders compose their own paths)
92pub use paths::{home_dir, xdg_cache_home, xdg_config_home, xdg_data_home, xdg_runtime_dir};
93
94// Tilde expansion utility
95pub use interpreter::expand_tilde;
96
97// Tool registration (for embedders registering custom tools)
98pub use tools::{Tool, ToolRegistry, ExecContext};
kaish_kernel/lib.rs

kaish_kernel/
lib.rs
