Create readmeForJsmon #1632
Create readmeForJsmon #1632
Conversation
WalkthroughAdds a new README/documentation section explaining how to use Jsmon as a data source in Subfinder, including prerequisites, credential retrieval, provider configuration (apiKey and wkspId), and command examples to run Subfinder with the Jsmon source. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
readmeForJsmon (2)
25-26: Wrap the run command in a code block and use a concrete domain.Improves readability and copy-paste-ability.
- Now you can run Subfinder using Jsmon as a source: - subfinder -d <domain> -sources jsmon + Now you can run Subfinder using Jsmon as a source: + ```bash + subfinder -d example.com -sources jsmon + ```
1-27: Reorganize Jsmon integration docs for better discoverabilityTo align with the repo’s documentation structure and make the new Jsmon data-source guide easy to find, please:
- Create a new file
docs/data-sources/jsmon.md
and move the contents ofreadmeForJsmoninto it (renaming as needed).- In the root
README.md:
- Add (or update) a Data Sources section.
- Link to the new Jsmon guide, for example:
## Data Sources - [Jsmon (Subfinder)](docs/data-sources/jsmon.md)- Remove or deprecate the original
readmeForJsmonfile once the new doc is live.This will group all provider-specific instructions under
docs/data-sources/and ensure users can easily navigate from the main README.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
readmeForJsmon(1 hunks)
🔇 Additional comments (1)
readmeForJsmon (1)
1-4: Good addition: clear purpose and prerequisites.The intro concisely states what Jsmon is and what credentials are needed. This sets context well for users.
| 1. Clone and build Subfinder | ||
| ```bash | ||
| git clone https://github.com/projectdiscovery/subfinder.git | ||
| cd subfinder | ||
| go build . | ||
| 2. Get your Jsmon API Key and Workspace ID |
There was a problem hiding this comment.
Close the code fence and fix the build command.
- The code block opened at Line 6 is never closed, which breaks Markdown rendering for the rest of the document.
- Building subfinder from the repo root with
go build .won’t produce the CLI binary. Build the subfinder command package instead.
Apply this diff:
```bash
- git clone https://github.com/projectdiscovery/subfinder.git
- cd subfinder
- go build .
+ git clone https://github.com/projectdiscovery/subfinder.git
+ cd subfinder
+ go build -o subfinder ./v2/cmd/subfinder
+```🤖 Prompt for AI Agents
In readmeForJsmon around lines 5–10 the Markdown code fence opened before the
git steps is never closed and the build step uses "go build ." which won't
produce the CLI binary; close the triple-backtick after the listed commands and
replace the build step with a build that compiles the subfinder command package
into a subfinder binary (e.g., build the ./v2/cmd/subfinder package and output a
subfinder binary).
| 3. Configure Subfinder for Jsmon | ||
| The Jsmon configuration format is: | ||
| apiKey:wkspId | ||
| apiKey → Your Jsmon API Key | ||
| wkspId → Your Workspace ID | ||
| Edit your Subfinder provider config file (~/.config/subfinder/provider-config.yaml) and add: | ||
| jsmon: | ||
| - "apiKey:yourWorkspaceId" |
There was a problem hiding this comment.
Correct the configuration format and example.
The current example suggests a literal string "apiKey:yourWorkspaceId", which mixes labels and placeholders. Subfinder provider credentials are typically supplied as a single string with colon-separated values. Clarify placeholders and show a proper YAML snippet.
Apply this diff:
- The Jsmon configuration format is:
- apiKey:wkspId
- apiKey → Your Jsmon API Key
- wkspId → Your Workspace ID
- Edit your Subfinder provider config file (~/.config/subfinder/provider-config.yaml) and add:
- jsmon:
- - "apiKey:yourWorkspaceId"
+ The Jsmon credential format is:
+ API_KEY:WORKSPACE_ID
+ - API_KEY: your Jsmon API key
+ - WORKSPACE_ID: your workspace ID
+ Edit your Subfinder provider config file (~/.config/subfinder/provider-config.yaml) and add:
+ ```yaml
+ jsmon:
+ - "YOUR_API_KEY:YOUR_WORKSPACE_ID"
+ ```🤖 Prompt for AI Agents
In readmeForJsmon around lines 16-23, the example mixes labels with
placeholders; update the description to state the format is a single
colon-separated string (apiKey:wkspId) and replace the example entry so the
provider-config.yaml snippet shows a single quoted credential string using
placeholders (e.g. YOUR_API_KEY:YOUR_WORKSPACE_ID), removing the literal
"apiKey:yourWorkspaceId" label mix, and ensure the YAML block is properly
closed.
Summary by CodeRabbit