[shadowmap] docs: simplify README onboarding#32
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting
| ```bash | ||
| cargo clippy -- -D warnings | ||
| ./target/release/shadowmap \ | ||
| --domain example.com \ | ||
| --providers aws,azure,gcp \ | ||
| --report markdown |
There was a problem hiding this comment.
[P1] Remove unsupported flags from quick-start command
The new onboarding example uses --providers and --report, but the CLI only accepts domain, concurrency, timeout, and retries. Running the command as written fails immediately (error: unexpected argument '--providers' found). This will block newcomers following the README, so the example should be updated to use the actual flags exposed by Args.
Useful? React with 👍 / 👎.
| ```bash | ||
| shadowmap -d target.com --json > report.json | ||
| export OPENAI_API_KEY="sk-..." | ||
| ./target/release/shadowmap --domain example.com --providers aws,azure,gcp --report markdown --gpt4 --poc |
There was a problem hiding this comment.
[P1] Remove nonexistent GPT-4 options from documentation
The GPT-4 reporting section instructs users to run --gpt4 --poc, but those flags are not defined anywhere in the crate (no gpt references in src/). Executing the example fails with error: unexpected argument '--gpt4' found, so the docs currently advertise a feature the binary cannot perform.
Useful? React with 👍 / 👎.
1 participant
Summary
Testing
https://chatgpt.com/codex/tasks/task_e_68d40fdb6a4c83269c7609aaee9d155d