Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make CMSeek installable #180

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,26 +51,24 @@ CMSeeK is built using **python3**, you will need python3 to run this tool and is

## Installation and Usage:

It is fairly easy to use CMSeeK, just make sure you have python3 and git (just for cloning the repo) installed and use the following commands:
It is fairly easy to use CMSeeK, just make sure you have python3, pipx (or pip) and git (just for cloning the repo) installed and use the following commands:

- git clone `https://github.com/Tuhinshubhra/CMSeeK`
- cd CMSeeK
- pip/pip3 install -r requirements.txt
- pipx install `git+https://github.com/Tuhinshubhra/CMSeeK`

For guided scanning:

- python3 cmseek.py
- cmseek

Else:

- python3 cmseek.py -u <target_url> [...]
- cmseek -u <target_url> [...]

Help menu from the program:

```
USAGE:
python3 cmseek.py (for guided scanning) OR
python3 cmseek.py [OPTIONS] <Target Specification>
cmseek (for guided scanning) OR
cmseek [OPTIONS] <Target Specification>

SPECIFING TARGET:
-u URL, --url URL Target Url
Expand Down Expand Up @@ -108,17 +106,17 @@ HELP & MISCELLANEOUS:
--batch Never ask you to press enter after every site in a list is scanned

EXAMPLE USAGE:
python3 cmseek.py -u example.com # Scan example.com
python3 cmseek.py -l /home/user/target.txt # Scan the sites specified in target.txt (comma separated)
python3 cmseek.py -u example.com --user-agent Mozilla 5.0 # Scan example.com using custom user-Agent Mozilla is 5.0 used here
python3 cmseek.py -u example.com --random-agent # Scan example.com using a random user-Agent
python3 cmseek.py -v -u example.com # enabling verbose output while scanning example.com
cmseek -u example.com # Scan example.com
cmseek -l /home/user/target.txt # Scan the sites specified in target.txt (comma separated)
cmseek -u example.com --user-agent Mozilla 5.0 # Scan example.com using custom user-Agent Mozilla is 5.0 used here
cmseek -u example.com --random-agent # Scan example.com using a random user-Agent
cmseek -v -u example.com # enabling verbose output while scanning example.com

```

## Checking For Update:

You can check for update either from the main menu or use `python3 cmseek.py --update` to check for update and apply auto update.
You can check for update either from the main menu or use `cmseek --update` to check for update and apply auto update.

P.S: Please make sure you have `git` installed, CMSeeK uses git to apply auto update.

Expand Down
Empty file added cmseek/__init__.py
Empty file.
File renamed without changes.
14 changes: 7 additions & 7 deletions cmseekdb/basic.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ def help():
Coded By:{1}{3} @r3dhax0r {2}

USAGE:
python3 cmseek.py (for guided scanning) OR
python3 cmseek.py [OPTIONS] <Target Specification>
cmseek (for guided scanning) OR
cmseek [OPTIONS] <Target Specification>

SPECIFING TARGET:
-u URL, --url URL Target Url
Expand Down Expand Up @@ -148,11 +148,11 @@ def help():
--batch Never ask you to press enter after every site in a list is scanned

EXAMPLE USAGE:
python3 cmseek.py -u example.com # Scan example.com
python3 cmseek.py -l /home/user/target.txt # Scan the sites specified in target.txt (comma separated)
python3 cmseek.py -u example.com --user-agent Mozilla 5.0 # Scan example.com using custom user-Agent Mozilla is 5.0 used here
python3 cmseek.py -u example.com --random-agent # Scan example.com using a random user-Agent
python3 cmseek.py -v -u example.com # enabling verbose output while scanning example.com
cmseek -u example.com # Scan example.com
cmseek -l /home/user/target.txt # Scan the sites specified in target.txt (comma separated)
cmseek -u example.com --user-agent Mozilla 5.0 # Scan example.com using custom user-Agent Mozilla is 5.0 used here
cmseek -u example.com --random-agent # Scan example.com using a random user-Agent
cmseek -v -u example.com # enabling verbose output while scanning example.com

""".format(cmseek_version,red, cln, bold, GIT_URL))
bye()
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,9 @@ def run(self):
# If your package is a single module, use this instead of 'packages':
# py_modules=['mypackage'],

# entry_points={
# 'console_scripts': ['mycli=mymodule:cli'],
# },
entry_points={
'console_scripts': ['cmseek=cmseek.cli:main'],
},
install_requires=REQUIRED,
extras_require=EXTRAS,
include_package_data=True,
Expand Down