{"id":34055017,"url":"https://github.com/webamon-org/webamon-cli","last_synced_at":"2026-03-17T22:40:22.225Z","repository":{"id":308629231,"uuid":"1033489672","full_name":"webamon-org/webamon-cli","owner":"webamon-org","description":"The Google of Threat Intelligence","archived":false,"fork":false,"pushed_at":"2025-08-13T03:01:36.000Z","size":233,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-15T21:24:17.027Z","etag":null,"topics":["blueteam-tools","cybersecurity","osint","osint-python","osint-tools","threat-hunting","threat-intelligence"],"latest_commit_sha":null,"homepage":"https://google.webamon.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webamon-org.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-06T22:36:28.000Z","updated_at":"2025-09-12T00:43:24.000Z","dependencies_parsed_at":"2025-08-07T01:18:44.952Z","dependency_job_id":"fd7845f4-077f-4c68-9bd7-9f2a191ecbde","html_url":"https://github.com/webamon-org/webamon-cli","commit_stats":null,"previous_names":["webamon-org/webamon-cli"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/webamon-org/webamon-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webamon-org%2Fwebamon-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webamon-org%2Fwebamon-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webamon-org%2Fwebamon-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webamon-org%2Fwebamon-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webamon-org","download_url":"https://codeload.github.com/webamon-org/webamon-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webamon-org%2Fwebamon-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30633580,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-17T22:38:22.569Z","status":"ssl_error","status_checked_at":"2026-03-17T22:38:11.804Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blueteam-tools","cybersecurity","osint","osint-python","osint-tools","threat-hunting","threat-intelligence"],"created_at":"2025-12-14T02:36:33.527Z","updated_at":"2026-03-17T22:40:22.217Z","avatar_url":"https://github.com/webamon-org.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Webamon Search CLI\n\n**The Google of Threat Intelligence**\n\nA powerful command-line interface for the Webamon Search API. Search \u0026 Threat Hunt across the web at scale. Returning unbiased \u0026 unfiltered results.\n\n## Installation\n\n### From PyPI\n\n```bash\npip install webamon-cli\n```\n\n\u003e **Webamon Search** - The Google of Threat Intelligence. Access millions of scanned domains, IPs, and threat indicators.\n\n### Global Installation (Linux/macOS)\n\n**Recommended: Install via Package Manager**\n```bash\n# Ubuntu/Debian\nsudo apt update \u0026\u0026 sudo apt install pipx\npipx install webamon-cli\npipx ensurepath\n\n# Fedora/CentOS/RHEL\nsudo dnf install pipx\npipx install webamon-cli\npipx ensurepath\n\n# macOS\nbrew install pipx\npipx install webamon-cli\npipx ensurepath\n\n# Arch Linux\nsudo pacman -S python-pipx\npipx install webamon-cli\npipx ensurepath\n```\n\n**Alternative: Install from Source**\n\nIf you need the latest development version or package managers don't work:\n\n1. Install pipx first:\n```bash\n# Ubuntu/Debian: sudo apt install pipx\n# Fedora/CentOS: sudo dnf install pipx  \n# macOS: brew install pipx\n# Arch: sudo pacman -S python-pipx\n```\n\n2. Clone and install:\n```bash\ngit clone https://github.com/webamon-org/webamon-cli.git\ncd webamon-cli\npipx install .\npipx ensurepath\n```\n\n**Verify Installation:**\n```bash\n# Test the installation\nwebamon --help\n\n# If command not found, add to PATH:\nexport PATH=\"$HOME/.local/bin:$PATH\"\n# Then restart your terminal or run:\nsource ~/.bashrc  # Linux\n# or\nsource ~/.zshrc   # macOS\n```\n\n### Development Installation\n\nFor development work:\n```bash\ngit clone https://github.com/webamon-org/webamon-cli.git\ncd webamon-cli\npython -m venv venv\nsource venv/bin/activate  # On Windows: venv\\Scripts\\activate\npip install -e .\n```\n\n## Quick Start\n\n**Install globally:**\n```bash\n# Ubuntu/Debian\nsudo apt install pipx \u0026\u0026 pipx install webamon-cli\n\n# Fedora/CentOS  \nsudo dnf install pipx \u0026\u0026 pipx install webamon-cli\n\n# macOS\nbrew install pipx \u0026\u0026 pipx install webamon-cli\n```\n\n**🚀 Start searching immediately - it's that simple!**\n\nUse the explicit search command:\n```bash\nwebamon search example.com       # Search for example.com\nwebamon search malware          # Search for malware\nwebamon search nrd_20250801     # Search latest domain registrations\n```\n\n**Other commands:**\n```bash\nwebamon search example.com     # Explicit search command\nwebamon configure             # Configure API key for pro features\nwebamon status               # Test connection\nwebamon scan https://example.com  # Scan a website\n```\n\n## Usage\n\n### API Endpoints\n\n**Webamon Search - The Google of Threat Intelligence**\n\nThe CLI automatically uses the appropriate endpoint:\n- **Free tier**: `search.webamon.com` (no API key required)\n- **Pro tier**: `pro.webamon.com` (requires API key)\n\n### Configuration\n\nThe CLI can be configured in several ways:\n\n1. **Interactive configuration:**\n```bash\nwebamon configure\n```\n\n2. **Environment variables:**\n```bash\nexport WEBAMON_API_KEY=\"your-api-key\"  # Optional, enables pro features\n```\n\n3. **Command-line options:**\n```bash\nwebamon --api-key your-key search example.com domain.name\n```\n\n4. **Configuration file:**\nThe CLI looks for configuration in:\n- `~/.webamon/config.json`\n- `.webamon.json` in current directory\n\n### Commands\n\n#### Search\n\nSearch the Webamon threat intelligence database:\n\n```bash\n# Search for domains, IPs, URLs, etc:\nwebamon search example.com           # Search for example.com\nwebamon search malware              # Search for malware  \nwebamon search 1.1.1.1             # Search for IP address\nwebamon search nrd_20250801 tag     # Search in specific field\n```\n\n**How it works:**\n- `webamon search \u003cSEARCH_TERM\u003e` - Basic search\n- `webamon search \u003cSEARCH_TERM\u003e \u003cRESULTS\u003e` - Search in specific fields\n- `SEARCH_TERM`: What you're searching for (domain, IP, URL, hash, etc.)\n- `RESULTS`: Comma-separated list of fields to search within\n  - **Default search fields**: `page_title,domain.name,resolved_url,dom,tag`\n  - **Custom search fields**: Specify your own field list\n- `--fields`: Comma-separated list of fields to return (separate from search fields)\n  - **Default return fields**: Same as search fields when not specified\n\n💡 **Search matches are highlighted with yellow background in table view.**\n\n**Examples:**\n```bash\n# Basic search\nwebamon search example.com\n\n# Search in specific fields\nwebamon search example.com domain.name,resolved_url\n\n# Custom return fields  \nwebamon search example.com --fields page_title,domain.name\n\n# Both custom search and return fields\nwebamon search example.com tag --fields page_title,domain.name\n\n# Different output formats\nwebamon search example.com --format json\nwebamon search example.com --format csv\n\n# Export results\nwebamon search example.com --export results.json\nwebamon search example.com --format csv --export analysis.csv\n```\n\n**Pagination (Pro Users Only):**\n```bash\n# Limit results with default fields\nwebamon search example.com --size 25\n\n# Use offset for pagination with default fields\nwebamon search example.com --from 25 --size 25\n\n# Use offset with custom fields\nwebamon search example.com domain.name,resolved_url --from 25 --size 25\n\n# Skip first 100 results with default fields\nwebamon search example.com --from 100 --size 50\n\n# Navigate large result sets\nwebamon search \"*.bank.com\" --from 0 --size 100\n```\n\n**Lucene Search:**\n```bash\n# Advanced Lucene queries\nwebamon search --lucene 'domain.name:\"bank*\" AND scan_status:success' --index scans\n\n# Specify fields to return\nwebamon search --lucene 'domain.name:\"example.com\"' --index scans --fields domain.name,page_title\n```\n\n#### Scan\nInitiate website scans:\n```bash\n# Scan a domain\nwebamon scan example.com\n\n# Scan and automatically fetch the report\nwebamon scan example.com --fetch-report\n\n# Scan a full URL\nwebamon scan https://example.com/login\n\n# JSON output with automatic report fetch\nwebamon scan example.com --format json --fetch-report\n```\n\n#### Report\nGet a specific scan report by ID:\n```bash\n# Get report details (JSON format by default)\nwebamon report bf18c02d-ff0e-46a9-9a59-5b7b94fb27fb\n\n# Table format for readable summary\nwebamon report bf18c02d-ff0e-46a9-9a59-5b7b94fb27fb --format table\n```\n\n#### Infostealers\nSearch for compromised credentials by domain:\n```bash\n# Search for compromised credentials\nwebamon infostealers example.com\n\n# Search domain with hyphens (automatically quoted)\nwebamon infostealers bank-site.com\n\n# Get more results (Pro users)\nwebamon infostealers example.com --size 50\n\n# Specify fields to return\nwebamon infostealers example.com --fields domain,username,password\n\n# JSON output\nwebamon infostealers example.com --format json\n\n# CSV output (auto-exports to file)\nwebamon infostealers example.com --format csv\n\n# Export to custom file\nwebamon infostealers example.com --export compromised_creds\nwebamon infostealers example.com --format csv --export creds.csv\n```\n\n#### Screenshot\nRetrieve scan screenshots:\n```bash\n# Get screenshot info\nwebamon screenshot bf18c02d-ff0e-46a9-9a59-5b7b94fb27fb\n\n# Save screenshot to file\nwebamon screenshot bf18c02d-ff0e-46a9-9a59-5b7b94fb27fb --save screenshot.png\n\n```\n\n#### Status\nCheck API connectivity:\n```bash\nwebamon status\n```\n\n#### Fields\nDiscover available scan fields:\n```bash\n# Show all available fields\nwebamon fields\n\n# Search for specific fields\nwebamon fields --search domain\n\n# Show fields by category\nwebamon fields --category certificate\n\n# Get fields as a simple list\nwebamon fields --search ip --format list\n```\n\n### Global Options\n\n- `--api-key`: Override API key  \n- `--config-file`: Use specific config file\n- `--verbose, -v`: Enable verbose output\n\n## Example Workflows\n\n### Security Research\n```bash\n# Search for subdomains\nwebamon search \"*.example.com\"\n\n# Scan suspicious domains\nwebamon scan suspicious-domain.com\n\n# Get screenshots of flagged sites\nwebamon screenshot \u003creport-id\u003e --save evidence.png\n```\n\n### Domain Intelligence\n```bash\n# Basic domain lookup\nwebamon search example.com domain.name,resolved_url,page_title\n\n# Advanced search with Lucene\nwebamon search --lucene 'domain.name:\"example.com\" AND scan_status:success' --index scans\n\n# Bulk domain analysis\nfor domain in $(cat domains.txt); do\n  webamon search $domain \u003e\u003e results.json\ndone\n```\n\n\n\n## Quotas and Pricing\n\n### Free Tier\n- **20 daily API calls**\n- **10 results per response**\n- Basic search functionality\n- Limited infostealer data access\n\n### Pro Plans\nWhen you hit the daily quota, the CLI will suggest upgrading to Pro for expanded access:\n\n- **Founding Analyst**: 1,000+ daily calls, up to 100 results per response\n- **Enterprise**: 10,000+ daily calls, up to 500 results per response\n- **All plans**: Complete infostealer data access, pagination, priority support\n\nFor current pricing and features, visit: https://webamon.com/pricing\n\nIf you exceed your quota, you'll see a helpful error message with upgrade information.\n\n## Configuration File Format\n\n```json\n{\n  \"api_key\": \"your-api-key-here\",\n  \"verbose\": false\n}\n```\n\n## Development\n\n### Setup Development Environment\n\n```bash\n# Clone and install\ngit clone https://github.com/webamon-org/webamon-cli.git\ncd webamon-cli\npython -m venv venv\nsource venv/bin/activate  # On Windows: venv\\Scripts\\activate\npip install -e .\n```\n\n### Building\n\n```bash\npython -m build\n```\n\n\n## Uninstall\n\n### Global Installation (pipx)\n```bash\npipx uninstall webamon-cli\n```\n\n### PyPI Installation\n```bash\npip uninstall webamon-cli\n```\n\n### Development Installation\n```bash\n# If installed with pip install -e .\npip uninstall webamon-cli\n\n# Remove the repository\nrm -rf webamon-cli\n```\n\n## License\n\nApache License 2.0\n\nCopyright 2025 Webamon\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n## Contributing\n\nWe welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines on:\n\n- Setting up your development environment\n- Code style and testing requirements  \n- Submitting bug reports and feature requests\n- Pull request process and code review\n\nQuick start: Fork → Branch → Code → Test → Pull Request\n\n## Security\n\nSecurity is important to us. Please see [SECURITY.md](SECURITY.md) for:\n\n- Reporting security vulnerabilities\n- Security best practices for users\n- API key and data protection guidelines\n- Incident response procedures","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebamon-org%2Fwebamon-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebamon-org%2Fwebamon-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebamon-org%2Fwebamon-cli/lists"}