Skip to main content

Capture and search infrastructure fixes for cloud/SRE engineers

Project description

FixDoc

A CLI tool for cloud engineers to capture and search infrastructure fixes. Stop losing tribal knowledge in Slack threads and personal notes.

When you hit a Terraform error or Kubernetes failure, pipe it directly into FixDoc. It auto-detects the error source, extracts structured metadata, and prompts you for the resolution. Next time you or a teammate hits the same issue, search your fix history instead of starting from scratch.

terraform apply 2>&1 | fixdoc capture
fixdoc search "S3"

Features

  • Pipe errors directly from terraform apply or kubectl — no copy-pasting
  • Auto-parse errors from Terraform (AWS, Azure, GCP) and Kubernetes
  • Similar fix suggestions — shows matching fixes from your history before creating duplicates
  • Search your fix history by keyword, tag, or error message
  • Watch mode — wrap any command and auto-capture errors on failure
  • Blast radius analysis — estimate the impact of Terraform changes before applying
  • Analyze Terraform plans against your fix history before apply
  • CI gating — fail pipelines when blast radius severity exceeds a threshold
  • Sync with your team via a shared Git repo
  • Markdown export — every fix generates a shareable .md file

Installation

pip install fixdoc

Requires Python 3.9+.

Contributing

git clone https://github.com/fiyiogunkoya/fixdoc.git
cd fixdoc
python3 -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"

Run tests with pytest. Format with black src/ tests/ and lint with ruff check src/ tests/.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fixdoc-0.0.3.tar.gz (95.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fixdoc-0.0.3-py3-none-any.whl (69.7 kB view details)

Uploaded Python 3

File details

Details for the file fixdoc-0.0.3.tar.gz.

File metadata

  • Download URL: fixdoc-0.0.3.tar.gz
  • Upload date:
  • Size: 95.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for fixdoc-0.0.3.tar.gz
Algorithm Hash digest
SHA256 ac26c549fd589cee57f23d40370d2807a7d575b643dcff76efdf33b4c051f03e
MD5 890bb0ffc63832e3c7be54b305463289
BLAKE2b-256 6379df281fcd6ec3fe699d27ce92aa4a9db04a4144a1bbbeefaf53428bb7606e

See more details on using hashes here.

File details

Details for the file fixdoc-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: fixdoc-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 69.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for fixdoc-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6c005b5dc46e152d8eec2685ecf84dcb494784287a8916091110e8ae139319a8
MD5 bec58dcf2741673db8426c70f9ae7f0a
BLAKE2b-256 a96847450db565bc47a2f42d521d57f17af28e84bb3884f576b43cd586b2f360

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page