How preludeorg/libraries works
Project type and purpose
• This is a polyglot, mono-repo of open-source “Prelude Libraries” that support Prelude’s Detect security platform.
• It contains three categories:
• Probes (shell scripts that execute tests on endpoints)
• SDKs (Python modules exposing Prelude’s Service API)
• Tests (Go-based harnesses for cloud, dropper, endpoint and network scenarios)
• It also includes auxiliary components: a Python CLI built on the SDK, a VS Code extension/devcontainer for local development, and GitHub Actions/workflows to build and ship “dropper” binaries and probes.
File structure
• Top-level directories:
• container/… → Docker/devcontainer definitions + VS Code extension client (React + TypeScript)
• go/tests/… → Go test harnesses for cloud, dropper, endpoint, network (with prebuilt binaries)
• python/cli/… → Prelude CLI (entry point + view modules)
• python/sdk/… → Prelude SDK (controllers, models, tests)
• shell/probe/… → Shell & PowerShell probe scripts
• CI/CD config under .github/workflows and .github/actions for packaging dropper & probes into GitHub Actions
• Configuration files: devcontainer.json, Dockerfiles, pyproject.toml, go.mod, tsconfig.json
README for additional insights
• Confirms the three core categories (Probes, SDK(s), Tests) and points out that the Python CLI is an example SDK client
• Mentions that probes are endpoint processes and that SDKs talk to the Prelude Service API
Detail is critical—capture each distinct piece
• Break the repository into as many logical components as you see folders (e.g., separate out Go/network tests vs. Go/dropper tests)
• External dependencies (e.g., Docker engine, GitHub Actions runner, target endpoints)
• Environment/configuration props (e.g., .env in client, devcontainer.json)