Consolidate documentation: move GEMINI.md content to AGENTS.md, expand README#11
Merged
Conversation
README.md was a 3-line stub; it now covers features, quickstart, CLI overview, and doc links. AGENTS.md (the canonical AI-agent doc, symlinked as CLAUDE.md) was missing the entire Java -javaagent integration (runner.rs injection, phantom-java-agent crate, build.rs auto-build, and its integration test) and the --fault flag details, despite both being implemented and tested. GEMINI.md had drifted into its own inconsistent copy (stale manual Java build steps, missing --bind/--fault/PHP docs); it's now a symlink to AGENTS.md like CLAUDE.md, so there's a single source of truth. docs/how-to-use.ja.md is also fixed: missing `run` subcommand in every example, stale manual Java Agent build steps, LD_PRELOAD listed as HTTP-only (it now covers HTTPS too), and a missing PHP section. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01D3AJ8QJXCGkqj2FgPajyNP
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.
Summary
This PR consolidates and expands the project's documentation by:
GEMINI.mdfile (replacing it with a symlink toAGENTS.md)README.mdwith a comprehensive feature overview, quickstart guide, and CLI referencedocs/how-to-use.ja.mdwith corrections and clarifications about Java/PHP support and the build processAGENTS.mdwith detailed sections on Java transparent proxy injection, integration test coverage, and fault injection specificationsKey Changes
Documentation Consolidation
GEMINI.md— replaced with a single-line symlink toAGENTS.mdto avoid duplicationREADME.mdfrom a minimal 3-line stub to a comprehensive guide including:Japanese Documentation Updates (
docs/how-to-use.ja.md)build.rshandles compilation automaticallycurl.cainfoand explicitCURLOPT_*overridesphantom run --syntax consistentlyAGENTS.md Enhancements
phantom-java-agent/andbuild.rsto project layoutproxy_java_clients_integration.rsandtests/apps/java-http-clients/to test structureJAVA_TOOL_OPTIONSinjection of proxy properties and-javaagentbuild.rscompilation ofAgent.javainto embedded jar--faultflag documentation with concrete examples and rule ordering semanticsImplementation Details
GEMINI.mdis now a symlink (GEMINI.md→AGENTS.md) to maintain backward compatibility while eliminating content duplicationbuild.rshandles Java Agent compilation transparently, with graceful degradation when JDK is unavailablehttps://claude.ai/code/session_01D3AJ8QJXCGkqj2FgPajyNP