docs: add agent guide and document local build, test, and run workflow#52
Merged
Conversation
Poltergeist shipped without any agent-facing instructions, and its README sent setup details to external docs, so a newcomer or coding agent cloning the repo had no local reference for how to build, test, or run it. The repository .gitignore also excluded these files outright, which is why none of them could be tracked. Add a CLAUDE.md agent guide covering the architecture, the make-based commands, the Hyperscan build requirement, and the rule format, an AGENTS.md symlink so non-Claude tools read the same guidance, a scoped .claude permission allowlist for the build and test commands, README sections for usage and the build and test workflow, and the .gitignore allowlist entries that let all of these be tracked.
joshlarsen
requested changes
Jun 30, 2026
Co-authored-by: Josh Larsen <[email protected]> Signed-off-by: Brad Geesaman <[email protected]>
Co-authored-by: Josh Larsen <[email protected]> Signed-off-by: Brad Geesaman <[email protected]>
joshlarsen
approved these changes
Jun 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds agent-facing documentation and local development guidance to the repository.