57 57 ## 💡 Usage 58 58 59 59 ```bash 60 + # Example Scan Commands: 61 + ## Start a simple scan with default 'general' flow 62 + osmedeus scan -t sample.com 63 + 64 + ## Start a general scan but exclude some of the module 65 + osmedeus scan -t sample.com -x screenshot -x spider 66 + 67 + ## Start a scan directly with a module with inputs as a list of http domains like this https://sub.example.com 68 + osmedeus scan -m content-discovery -t http-file.txt 69 + 70 + ## Initiate the scan using a speed option other than the default setting 71 + osmedeus scan -f vuln --tactic gently -t sample.com 72 + osmedeus scan --threads-hold=10 -t sample.com 73 + osmedeus scan -B 5 -t sample.com 74 + 75 + ## Start a simple scan with other flow 76 + osmedeus scan -f vuln -t sample.com 77 + osmedeus scan -f extensive -t sample.com -t another.com 78 + osmedeus scan -f urls -t list-of-urls.txt 79 + 80 + ## Scan list of targets 81 + osmedeus scan -T list_of_targets.txt 82 + osmedeus scan -f vuln -T list-of-targets.txt 83 + 84 + ## Performing static vulnerability scan and secret scan on a git repo 85 + osmedeus scan -m repo-scan -t https://github.com/j3ssie/sample-repo 86 + osmedeus scan -m repo-scan -t /tmp/source-code-folder 87 + osmedeus scan -m repo-scan -T list-of-repo.txt 88 + 89 + ## Scan for CIDR with file contains CIDR with the format '1.2.3.4/24' 90 + osmedeus scan -f cidr -t list-of-ciders.txt 91 + osmedeus scan -f cidr -t '1.2.3.4/24' # this will auto convert the single input to the file and run 92 + 93 + ## Directly run on vuln scan and directory scan on list of domains 94 + osmedeus scan -f domains -t list-of-domains.txt 95 + osmedeus scan -f vuln-and-dirb -t list-of-domains.txt 96 + 97 + ## Use a custom wordlist 98 + osmedeus scan -t sample.com -p 'wordlists={{Data}}/wordlists/content/big.txt' 99 + 100 + ## Use a custom wordlist 101 + cat list_of_targets.txt | osmedeus scan -c 2 102 + 103 + ## Start a normal scan and backup entire workflow folder to the backup folder 104 + osmedeus scan --backup -f domains -t list-of-subdomains.txt 105 + 106 + ## Start the scan with chunk inputs to review the output way more much faster 107 + osmedeus scan --chunk --chunk-parts 20 -f cidr -t list-of-100-cidr.txt 108 + 109 + ## Continuously run the scan on a target right after it finished 110 + osmedeus utils cron --for --cmd 'osmedeus scan -t example.com' 111 + 112 + ## Backing up all workspaces 113 + ls ~/workspaces-osmedeus | osmedeus report compress 114 + 115 + 60 116 # Scan Usage: 61 117 osmedeus scan -f [flowName] -t [target] 62 118 osmedeus scan -m [modulePath] -T [targetsFile] 63 119 osmedeus scan -f /path/to/flow.yaml -t [target] 64 - osmedeus scan --threads-hold=30 -f cidr -t 1.2.3.4/24 120 + osmedeus scan -m /path/to/module.yaml -t [target] --params 'port=9200' 65 121 osmedeus scan -m /path/to/module.yaml -t [target] -l /tmp/log.log 122 + osmedeus scan --tactic aggressive -m module -t [target] 66 123 cat targets | osmedeus scan -f sample 67 124 68 125 # Practical Scan Usage: 72 129 osmedeus scan --tactic aggressive -f general -t sample.com 73 130 osmedeus scan -f extensive -t sample.com -t another.com 74 131 cat list_of_urls.txt | osmedeus scan -f urls 75 - osmedeus scan --threads-hold=30 -f cidr -t 1.2.3.4/24 132 + osmedeus scan --threads-hold=15 -f cidr -t 1.2.3.4/24 76 133 osmedeus scan -m ~/.osmedeus/core/workflow/test/dirbscan.yaml -t list_of_urls.txt 77 134 osmedeus scan --wfFolder ~/custom-workflow/ -f your-custom-workflow -t list_of_urls.txt 78 135 osmedeus scan --chunk --chunk-part 40 -c 2 -f cidr -t list-of-cidr.txt 79 136 80 - # Queue Usage: 81 - osmedeus queue -Q /tmp/queue-file.txt -c 2 82 - osmedeus queue --add -t example.com -Q /tmp/queue-file.txt 83 - 84 - # Provider Usage: 85 - osmedeus provider wizard 86 - osmedeus provider validate 87 - osmedeus provider build --token xxx --rebuild --ic 88 - osmedeus provider create --name 'sample' 89 - osmedeus provider health --debug 90 - osmedeus provider list 91 - osmedeus provider delete --id 34317111 --id 34317112 92 - 93 - # Cloud Usage: 94 - osmedeus cloud -f [flowName] -t [target] 95 - osmedeus cloud -m [modulePath] -t [target] 96 - osmedeus cloud -c 5 -f [flowName] -T [targetsFile] 97 - osmedeus cloud --token xxx -c 5 -f [flowName] -T [targetsFile] 98 - osmedeus cloud --chunk -c 5 -f [flowName] -t [targetsFile] 99 - 100 - # Utilities Usage: 101 - ## Health check utility 102 - osmedeus health 103 - osmedeus health git 104 - osmedeus health cloud 105 - osmedeus version --json 106 - ## Update utility 107 - osmedeus update 108 - osmedeus update --vuln 109 - osmedeus update --force --clean 110 - ## Other utilities 111 - osmedeus utils tmux ls 112 - osmedeus utils tmux logs -A -l 10 113 - osmedeus utils ps 114 - osmedeus utils ps --proc 'jaeles' 115 - osmedeus utils cron --cmd 'osmdeus scan -t example.com' --sch 60 116 - osmedeus utils cron --for --cmd 'osmedeus scan -t example.com' 117 - osmedeus utils workflow 118 - osmedeus config set --threads-hold=10 137 + 💡 For full help message, please run: osmedeus --hh or osmedeus scan --hh 138 + 📖 Documentation can be found here: https://docs.osmedeus.org 119 139 ``` 120 140 121 - Check out [**this page**](https://docs.osmedeus.org/installation/usage/) for full usage and the [**Practical 122 - Usage**](https://docs.osmedeus.org/installation/practical-usage/) to see how to use Osmedeus in a practical way. 141 + Check out [**this page**](https://docs.osmedeus.org/installation/usage/) for full usage and the [**Practical Usage * * ] ( https : / / docs . osmedeus . org / installation / practical - usage / ) to see how to use Osmedeus in a practical way . 123 142 124 143 ## 💬 Community & Discussion 125 144
