Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/idank/explainshell
/ types & classes
Types & classes
195 in github.com/idank/explainshell
⨍
Functions
2,183
◇
Types & classes
195
↳
Endpoints
100
↓ 38 callers
Class
BatchResult
Aggregated result from running an extractor over multiple files. ``stats`` accumulates SUCCESS outcomes plus batch-level token counts. In bat
explainshell/extraction/types.py:93
↓ 38 callers
Class
ParsedManpage
processed man page source - the path to the original source man page name - the name of this man page as extracted by manpage.manpage syn
explainshell/models.py:79
↓ 35 callers
Class
ExtractionResult
Per-file extraction result. For SUCCESS, ``mp`` and ``raw`` are populated. For SKIPPED/FAILED, ``error`` describes why; ``stats`` may still c
explainshell/extraction/types.py:70
↓ 35 callers
Class
Option
An extracted command-line option from a man page. short - a list of short options (-a, -b, ..) long - a list of long options (--a, --b) h
explainshell/models.py:47
↓ 24 callers
Class
MatchResult
A single matched token span in the input command line.
explainshell/matcher.py:35
↓ 23 callers
Class
OpenAIProvider
Implements LLMProvider + BatchProvider for OpenAI.
explainshell/extraction/llm/providers/openai.py:55
↓ 22 callers
Class
ExtractionStats
Extensible bag of metrics. Adding a stat = one new field with a default. All additive fields default to zero so that aggregate accumulators (
explainshell/extraction/types.py:14
↓ 22 callers
Class
_NullBatchManifestWriter
No-op BatchManifestWriter that discards all calls.
explainshell/extraction/runner.py:35
↓ 21 callers
Class
TokenUsage
Simple container for token counts.
explainshell/extraction/llm/providers/__init__.py:9
↓ 19 callers
Class
ExtractionError
explainshell/errors.py:50
↓ 19 callers
Class
_FakeStore
Minimal Store stand-in covering the four methods Classifier/apply touch.
tests/extraction/test_prefilter.py:25
↓ 13 callers
Class
Store
read/write processed man pages from sqlite
explainshell/store.py:107
↓ 12 callers
Class
RawManpage
explainshell/models.py:19
↓ 11 callers
Class
BatchResults
Return type for BatchProvider.collect_results.
explainshell/extraction/llm/providers/__init__.py:34
↓ 10 callers
Class
CodexProvider
Implements LLMProvider by shelling out to ``codex exec``. Uses ``--json`` to get JSONL output on stdout, which includes ``item.completed`` ev
explainshell/extraction/llm/providers/codex.py:16
↓ 10 callers
Class
ExtractorConfig
Shared configuration for all extractors. ``run_dir``: single directory for all run artifacts (logs, debug files, failed responses). When set
explainshell/extraction/types.py:111
↓ 9 callers
Class
FileBatchManifestWriter
Thread-safe manifest writer for batch extraction runs. Records batch outcomes incrementally and flushes to disk after each update.
explainshell/extraction/manifest.py:52
↓ 6 callers
Class
FatalExtractionError
Unrecoverable error that should abort the entire run.
explainshell/errors.py:84
↓ 6 callers
Class
_FakeExtractor
Fake that satisfies BatchExtractor for isinstance checks. Uses MagicMock for method bodies so tests can inspect calls and set side_effects.
tests/extraction/test_runner.py:50
↓ 5 callers
Class
ExtractionMeta
Side-band metadata attached to an extracted manpage. The extractor name itself lives on ``ParsedManpage.extractor`` (and the matching DB colu
explainshell/models.py:27
↓ 4 callers
Class
DbCounts
explainshell/extraction/report.py:44
↓ 4 callers
Class
ExtractSummary
explainshell/extraction/report.py:33
↓ 4 callers
Class
LLMExtractor
LLM-based option extractor. Implements the base ``Extractor`` protocol via ``extract()``. Also satisfies ``BatchExtractor`` via ``prepare()``
explainshell/extraction/llm/extractor.py:188
↓ 4 callers
Class
MatchGroup
a class to group matchresults together we group all shell results in one group and create a new group for every command
explainshell/matcher.py:13
↓ 4 callers
Class
PreparedFile
Result of LLMExtractor.prepare() — everything needed for extraction. Fields ------ synopsis: Synopsis line from lexgrog, or None.
explainshell/extraction/llm/extractor.py:130
↓ 4 callers
Class
SkippedExtraction
File was intentionally skipped (not a failure).
explainshell/errors.py:69
↓ 3 callers
Class
ExtractionReport
explainshell/extraction/report.py:142
↓ 3 callers
Class
Result
tools/loadtest.py:173
↓ 3 callers
Class
SizeSkip
explainshell/extraction/prefilter.py:38
↓ 3 callers
Class
Symlink
explainshell/extraction/prefilter.py:61
↓ 3 callers
Class
Work
explainshell/extraction/prefilter.py:32
↓ 2 callers
Class
AlreadyStored
explainshell/extraction/prefilter.py:47
↓ 2 callers
Class
CachingStore
Read-only Store variant with a size-aware LRU for repeated lookups.
explainshell/caching_store.py:93
↓ 2 callers
Class
ChunkResult
Result of a single LLM call for one chunk.
explainshell/extraction/llm/extractor.py:179
↓ 2 callers
Class
ContentDup
explainshell/extraction/prefilter.py:70
↓ 2 callers
Class
ExtractConfig
explainshell/extraction/report.py:20
↓ 2 callers
Class
FilterSkip
explainshell/extraction/prefilter.py:53
↓ 2 callers
Class
GeminiProvider
Implements LLMProvider + BatchProvider for Gemini.
explainshell/extraction/llm/providers/gemini.py:25
↓ 2 callers
Class
GitInfo
explainshell/extraction/report.py:14
↓ 2 callers
Class
WorkItem
A file that passed the prepare phase and is ready for batch extraction.
explainshell/extraction/runner.py:85
↓ 1 callers
Class
BatchEntry
A single entry in a batch.
explainshell/extraction/llm/providers/__init__.py:42
↓ 1 callers
Class
BatchManifest
Top-level manifest schema — used for reading and validation.
explainshell/extraction/manifest.py:27
↓ 1 callers
Class
BatchManifestEntry
One batch's record in the manifest.
explainshell/extraction/manifest.py:17
↓ 1 callers
Class
Classified
explainshell/extraction/prefilter.py:196
↓ 1 callers
Class
Classifier
explainshell/extraction/prefilter.py:110
↓ 1 callers
Class
FailureEntry
One file that failed extraction, with classification.
explainshell/extraction/report.py:126
↓ 1 callers
Class
InterceptHandler
intercept log messages logged with the logging module source: https://loguru.readthedocs.io/en/stable/overview.html#entirely-compatible-with
explainshell/logger/logging_interceptor.py:9
↓ 1 callers
Class
LoopStats
tools/loadtest.py:294
↓ 1 callers
Class
ManpageCacheInfo
Runtime stats for CachingStore's manpage lookup cache.
explainshell/caching_store.py:23
↓ 1 callers
Class
PostProcessStats
explainshell/extraction/postprocess.py:27
↓ 1 callers
Class
RenderedPage
tests/evals/render/render_eval.py:117
↓ 1 callers
Class
SkipEntry
One file the extractor intentionally skipped, with classification.
explainshell/extraction/report.py:134
↓ 1 callers
Class
Stats
tools/postprocess_ubuntu_archive.py:35
↓ 1 callers
Class
SubcommandMappingResult
Result of update_subcommand_mappings.
explainshell/store.py:100
↓ 1 callers
Class
TagCounter
Tiny HTML structural counter using the standard library parser.
tests/evals/render/render_eval.py:87
↓ 1 callers
Class
TokenUsage
Aggregate LLM token usage across all successful extractions in a run.
explainshell/extraction/report.py:49
↓ 1 callers
Class
_BatchOutput
Return value from processing one provider batch.
explainshell/extraction/runner.py:95
↓ 1 callers
Class
_FindManpageMiss
Cached miss for find_man_page lookups.
explainshell/caching_store.py:14
↓ 1 callers
Class
_InflightBatches
Thread-safe registry of in-flight provider batches. Used to cancel batches on KeyboardInterrupt so they don't linger on the provider side aft
explainshell/extraction/runner.py:52
↓ 1 callers
Class
depthchecker
tests/test_matcher.py:807
Class
explainshell/web/static/js/highlight.min.js:12
Class
explainshell/web/static/js/highlight.min.js:18
Class
explainshell/web/static/js/highlight.min.js:27
Class
explainshell/web/static/js/highlight.min.js:38
Class
explainshell/web/static/js/highlight.min.js:127
Class
explainshell/web/static/js/highlight.min.js:136
Class
explainshell/web/static/js/highlight.min.js:172
Class
explainshell/web/static/js/es.js:188
Class
explainshell/web/static/js/es.js:201
Class
explainshell/web/static/js/es.js:258
Class
BatchExtractor
Extractor that supports batch execution via a provider API.
explainshell/extraction/llm/extractor.py:165
Class
BatchManifestWriter
Protocol for batch manifest writers used by the runner.
explainshell/extraction/manifest.py:37
Class
BatchProvider
Batch API interface (not all providers support this).
explainshell/extraction/llm/providers/__init__.py:54
Struct
Botshed
prod/botshed/module.go:45
Class
DuplicateManpage
explainshell/errors.py:8
Class
ESLink
explainshell/web/static/js/es.js:201
Class
ESLinkGroup
explainshell/web/static/js/es.js:188
Class
ESPath
explainshell/web/static/js/es.js:258
Class
ExtractionOutcome
explainshell/extraction/types.py:63
Class
Extractor
explainshell/extraction/types.py:136
Class
FailureReason
Classification of why an extraction skipped or failed. Set at the throw site so analysis tools (e.g. report.json consumers) don't have to reg
explainshell/errors.py:16
Class
InvalidSourcePath
explainshell/errors.py:12
Class
J
explainshell/web/static/js/highlight.min.js:172
Class
LLMProvider
Single-file call interface.
explainshell/extraction/llm/providers/__init__.py:25
Class
Matcher
parse a command line and return a list of `MatchResult`s describing each token.
explainshell/matcher.py:70
Class
OptionCountSummary
Distribution of per-page option counts across successful extractions.
explainshell/extraction/report.py:59
Class
Peekable
>>> it = Peekable(iter('abc')) >>> it.index, it.peek(), it.index, it.peek(), next(it), it.index, it.peek(), next(it), next(it), it.index
explainshell/util.py:29
Class
ProgramDoesNotExist
explainshell/errors.py:4
Class
RecordingExecutor
tests/extraction/test_runner.py:629
Class
TestAddManpageDuplicatePrevention
tests/test_store.py:209
Class
TestApplyDecisions
tests/extraction/test_prefilter.py:306
Class
TestAtFileExpansion
Tests that @file arguments are expanded through the CLI.
tests/test_manager.py:2499
Class
TestAzureRouting
Azure-prefixed models should route through the OpenAI-compatible provider.
tests/extraction/llm/test_openai_provider.py:667
Class
TestBatchFileCleanup
collect_results should delete input/output/error files after collection.
tests/extraction/llm/test_openai_provider.py:773
Class
TestBatchPerBatchDbWrites
Verify the manager writes results to the DB via on_result callback from run().
tests/test_manager.py:103
Class
TestBuildPreamble
tests/extraction/llm/test_text.py:215
Class
TestBuildUserContent
tests/extraction/llm/test_extractor.py:405
Class
TestCheck
tests/test_db_check.py:44
Class
TestChunkText
tests/extraction/llm/test_text.py:125
Class
TestClassifyAlreadyStored
tests/extraction/test_prefilter.py:244
next →
1–100 of 195, ranked by callers