Merge pull request #35 from hueristiq/dev

Development v0.3.0

.github/workflows/release.yml

@@ -26,8 +26,10 @@ jobs:
                 name: Run GoReleaser
                 uses: goreleaser/goreleaser-action@v4
                 with:
-                    args: "release --clean"
+                    distribution: goreleaser
                     version: latest
+                    args: "release --clean"
+                    workdir: .
                 env:
                     GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
                     SLACK_WEBHOOK: "${{ secrets.SLACK_WEBHOOK }}"

.goreleaser.yaml

@@ -39,8 +39,6 @@ archives:
         id: tgz
         builds: [xurlfind3r-cli]
         format: tar.gz
-        replacements:
-            darwin: macOS
         format_overrides:
             -
                 goos: windows

README.md

@@ -22,18 +22,12 @@
 
 ## Features
 
-* Fetches URLs from curated passive sources to maximize results:
-	* **[AlienVault's OTX](https://otx.alienvault.com/)**
-	* **[BeVigil](https://bevigil.com)**
-	* **[Common Crawl](https://commoncrawl.org/)**
-	* **[URLScan](https://urlscan.io/)**
-	* **[Github](https://github.com)**
-	* **[Intelligence X](https://intelx.io)**
-	* **[Wayback Machine](https://archive.org/web/)**
-* With Wayback Machine, Parses URLs from `robots.txt` snapshots.
-* With Wayback Machine, Parses URLs from webpages' snapshots.
-* Cross-Platform (Windows, Linux & macOS)
-* Supports URLs match and filter
+* Fetches URLs from curated passive sources to maximize results.
+	* **[AlienVault's OTX](https://otx.alienvault.com/)** ◇ **[BeVigil](https://bevigil.com)** ◇ **[Common Crawl](https://commoncrawl.org/)** ◇ **[Github](https://github.com)** ◇ **[Intelligence X](https://intelx.io)** ◇ **[URLScan](https://urlscan.io/)** ◇ **[Wayback Machine](https://archive.org/web/)**
+* Parses URLs from wayback webpages and `robots.txt` snapshots.
+* Supports URLs matching and filtering.
+* Supports `stdin` and `stdout` for easy integration into workflows.
+* Cross-Platform (Windows, Linux & macOS).
 
 ## Installation
 
@@ -118,7 +112,7 @@ go install -v github.com/hueristiq/xurlfind3r/cmd/xurlfind3r@latest
 Example `config.yaml`:
 
 ```yaml
-version: 0.2.0
+version: 0.3.0
 sources:
     - bevigil
     - commoncrawl
@@ -154,35 +148,37 @@ help message:
 __  ___   _ _ __| |/ _(_)_ __   __| |___ / _ __ 
 \ \/ / | | | '__| | |_| | '_ \ / _` | |_ \| '__|
  >  <| |_| | |  | |  _| | | | | (_| |___) | |
-/_/\_\\__,_|_|  |_|_| |_|_| |_|\__,_|____/|_| v0.2.0
+/_/\_\\__,_|_|  |_|_| |_|_| |_|\__,_|____/|_| v0.3.0
 
 USAGE:
   xurlfind3r [OPTIONS]
 
-TARGET:
- -d, --domain string              (sub)domain to match URLs
+INPUT:
+ -d, --domain string[]               target domains
+ -l, --list string                   target domains' list file path
 
 SCOPE:
-     --include-subdomains bool    match subdomain's URLs
+     --include-subdomains bool       match subdomain's URLs
 
 SOURCES:
- -s,  --sources bool              list sources
- -u,  --use-sources string        sources to use (default: bevigil,commoncrawl,github,intelx,otx,urlscan,wayback)
-      --skip-wayback-robots bool  with wayback, skip parsing robots.txt snapshots
-      --skip-wayback-source bool  with wayback, skip parsing source code snapshots
+      --sources bool                 list supported sources
+ -u,  --use-sources string[]         comma(,) separated sources to use
+ -e,  --exclude-sources string[]     comma(,) separated sources to exclude
+      --parse-wayback-robots bool    with wayback, parse robots.txt snapshots
+      --parse-wayback-source bool    with wayback, parse source code snapshots
 
 FILTER & MATCH:
- -f, --filter string              regex to filter URLs
- -m, --match string               regex to match URLs
+ -f, --filter string                 regex to filter URLs
+ -m, --match string                  regex to match URLs
 
 OUTPUT:
-     --no-color bool              no color mode
- -o, --output string              output URLs file path
- -v, --verbosity string           debug, info, warning, error, fatal or silent (default: info)
+     --no-color bool                 disable colored output
+ -o, --output string                 output URLs file path
+ -O, --output-directory string       output URLs directory path
+ -v, --verbosity string              debug, info, warning, error, fatal or silent (default: info)
 
 CONFIGURATION:
- -c,  --configuration string      configuration file path (default: ~/.hueristiq/xurlfind3r/config.yaml)
-
+ -c,  --configuration string         configuration file path (default: ~/.hueristiq/xurlfind3r/config.yaml)
 ```
 
 ### Examples
@@ -209,8 +205,8 @@ xurlfind3r -d hackerone.com --include-subdomains -m '^https?://[^/]*?/.*\.js(\?[
 
 ## Contributing
 
-[Issues](https://github.com/hueristiq/xurlfind3r/issues) and [Pull Requests](https://github.com/hueristiq/xurlfind3r/pulls) are welcome! **Check out the [contribution guidelines](./CONTRIBUTING.md).**
+[Issues](https://github.com/hueristiq/xurlfind3r/issues) and [Pull Requests](https://github.com/hueristiq/xurlfind3r/pulls) are welcome! **Check out the [contribution guidelines](https://github.com/hueristiq/xurlfind3r/blob/master/CONTRIBUTING.md).**
 
 ## Licensing
 
-This utility is distributed under the [MIT license](./LICENSE).
+This utility is distributed under the [MIT license](https://github.com/hueristiq/xurlfind3r/blob/master/LICENSE).