Evidence-grounded project docs your team and AI agents can trust — every operational claim cites a source file, and gaps are stated instead of invented.
"Push to main; CI builds a Docker image and deploys to AWS ECS."
Looks plausible. Not supported by the sampled source.
No deployment configuration was found. The sampled source has no Dockerfile, no CI workflow, no Makefile, and no hosting-provider config.
Evidence: 03-deployment-manual.md + assumptions.md
pytest -q runs the test suite.
pyproject.toml dev dependency + tests/.
tracedocs is a deterministic, offline CLI that scans a repository and
writes a structured study-docs/ package.
| Evidence | Confidence |
|---|---|
pyproject.toml, project_to_study/*.py, tests/ | Verified |
Copy-paste commands are sourced from package metadata and tests.
python3 -m venv .venv .venv/bin/pip install -e ".[dev]" tracedocs /path/to/repo --out study-docs pytest -q
| Evidence | Confidence |
|---|---|
pyproject.toml scripts/dev deps; tests/ | Verified |
Documents day-to-day execution, validation, and local troubleshooting for a zero-service CLI: no daemon, no database, no runtime env vars.
| Evidence | Confidence |
|---|---|
cli.py, validate.py, model.py | Verified |
No deployment configuration was found. This is the signature behaviour: tracedocs records the gap instead of inventing a cloud pipeline.
| Evidence | Confidence |
|---|---|
Absence of Dockerfile, .github/workflows/, Makefile | Verified |
Turns the repo into a reading path: start with CLI entry, follow source acquisition, scan facts, analyze routes/entities, then read the writer.
| Evidence | Confidence |
|---|---|
cli.py, source.py, scanner.py, writer.py | Verified |
Maps the core pipeline from cli.main through scanning,
analysis, Markdown generation, evidence writing, and validation.
| Evidence | Confidence |
|---|---|
cli.py, scanner.py, analyzers.py, evidence.py | Verified |
Shows the deterministic extraction pipeline and calls out the main tradeoff: heuristic extraction is fast and simple, but can miss unusual code styles.
| Evidence | Confidence |
|---|---|
model.py, scanner.py, analyzers.py | Verified / Inferred risk |
There is no HTTP API. The public surface is the CLI:
generate, validate, and --version.
The only external integration is optional git clone --depth 1.
| Evidence | Confidence |
|---|---|
cli.py, source.py | Verified |
No database. The model is a set of in-memory dataclasses:
ProjectFacts, Command, EnvVar,
Route, Entity, and Claim.
| Evidence | Confidence |
|---|---|
model.py, writer.py | Verified |
Common failures are concrete: command not found, bad target path, missing
git for Git URLs, broken links in generated docs, and secret
leakage checks.
| Evidence | Confidence |
|---|---|
source.py, validate.py, tests/ | Verified |
Documents the safe change workflow and the confirmed gap: PyPI publishing and release cadence are not configured in this repository.
| Evidence | Confidence |
|---|---|
pyproject.toml, absent publish workflow, tests/ | Verified / Needs confirmation |
The package ships a compact manifest of docs, commands, confidence counts, unknowns, evidence files, routes, and entities.
{
"commands": {
"install": "pip install -e \".[dev]\"",
"run": "tracedocs <path> --out study-docs",
"test": "pytest -q"
},
"confidence": {
"verified": 14,
"inferred": 1,
"needs_confirmation": 1
}
}