| Name | subbud JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | https://github.com/4riful/subbud |
| Summary | A short description of the package |
| upload_time | 2024-07-16 18:58:53 |
| maintainer | None |
| docs_url | None |
| author | Your Name |
| requires_python | >=3.6 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# SubBud - Bug Bounty Subdomain Management Tool 🐞
**SubBud** is a versatile command-line tool designed to simplify the management of subdomains (collected form various sources) for bug bounty hunters and security researchers. It provides features to add, print, list, delete, and save subdomains for different projects, helping you keep track of your bug bounty targets effectively. 🎯
## Table of Contents 📋
- [Installation](#installation)
- [Usage](#usage)
- [Adding Subdomains](#adding-subdomains)
- [Printing Subdomains](#printing-subdomains)
- [Listing Projects](#listing-projects)
- [Deleting Projects](#deleting-projects)
- [Saving Merged Subdomains](#saving-merged-subdomains)
- [Requirements](#requirements)
- [Contributing](#contributing)
- [License](#license)
# Installation 🚀 <a name="installation"></a>
SubBud is available on PyPI, and you can easily install it using pip:
```bash
pip install subbud
```
# Usage 🛠️ <a name="usage"></a>
SubBud offers various operations to manage your subdomains effectively.
## Adding Subdomains ➕<a name="adding-subdomains"></a>
To add subdomains to a project, use the `-o add` operation
```
subbud -p project_name -o add -f subdomainsfromamass.txt
```
- `-p project_name`: The name of your project.
- `-o add`: Specifies the operation to add subdomains.
- `-f subdomains.txt`: The file containing subdomains to add.
## Printing Subdomains 🖨️ <a name="printing-subdomains"></a>
To print merged/unique subdomains for a project, use the -o print operation:
```bash
subbud -p project_name -o print
```
- `-p project_name`: The name of your project.
- `-o print`: Specifies the operation to print subdomains.
## Listing Projects 📃<a name="listing-projects"></a>
To list all available projects, use the `-o list` operation:
```
subbud -o list
```
- `-o list`: Lists all available projects
## Deleting Projects ❌<a name="deleting-projects"></a>
To delete a project and its associated subdomains, use the `-o delete `operation:
```
subbud -p project_name -o delete
```
## Saving Merged Subdomains 💾<a name="saving-merged-subdomains"></a>
To save the merged subdomains to a text file on the current directory , use the `-o save` operation:
it will save it with the current date and project name.
```
subbud -p project_name -o save
```
## Requirements ⚙️<a name="requirements"></a>
- Python 3.x
- Redis Server (Make sure the Redis server is running) 🛠️
## Contributing 🤝<a name="contributing"></a>
Contributions to SubBud are welcome! If you have any suggestions, improvements, or bug fixes, please open an issue or create a pull request !
Inspired by [@jhaddix](https://github.com/jhaddix) ❤️ Sir !
Raw data
{
"_id": null,
"home_page": "https://github.com/4riful/subbud",
"name": "subbud",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "your.email@example.com",
"download_url": "https://files.pythonhosted.org/packages/cf/e1/55b4d3a9fa4e454d0241db048c5da707ec2d6bd568a0b25aeb2a1f139cfc/subbud-0.0.2.tar.gz",
"platform": null,
"description": "# SubBud - Bug Bounty Subdomain Management Tool \ud83d\udc1e\n\n**SubBud** is a versatile command-line tool designed to simplify the management of subdomains (collected form various sources) for bug bounty hunters and security researchers. It provides features to add, print, list, delete, and save subdomains for different projects, helping you keep track of your bug bounty targets effectively. \ud83c\udfaf\n\n## Table of Contents \ud83d\udccb\n\n- [Installation](#installation)\n- [Usage](#usage)\n - [Adding Subdomains](#adding-subdomains)\n - [Printing Subdomains](#printing-subdomains)\n - [Listing Projects](#listing-projects)\n - [Deleting Projects](#deleting-projects)\n - [Saving Merged Subdomains](#saving-merged-subdomains)\n- [Requirements](#requirements)\n- [Contributing](#contributing)\n- [License](#license)\n\n# Installation \ud83d\ude80 <a name=\"installation\"></a>\n\nSubBud is available on PyPI, and you can easily install it using pip:\n\n```bash\npip install subbud\n```\n# Usage \ud83d\udee0\ufe0f <a name=\"usage\"></a>\nSubBud offers various operations to manage your subdomains effectively.\n\n## Adding Subdomains \u2795<a name=\"adding-subdomains\"></a>\n\nTo add subdomains to a project, use the `-o add` operation\n\n```\nsubbud -p project_name -o add -f subdomainsfromamass.txt\n```\n- `-p project_name`: The name of your project.\n- `-o add`: Specifies the operation to add subdomains.\n- `-f subdomains.txt`: The file containing subdomains to add.\n## Printing Subdomains \ud83d\udda8\ufe0f <a name=\"printing-subdomains\"></a>\nTo print merged/unique subdomains for a project, use the -o print operation:\n```bash\nsubbud -p project_name -o print\n```\n- `-p project_name`: The name of your project.\n- `-o print`: Specifies the operation to print subdomains.\n\n## Listing Projects \ud83d\udcc3<a name=\"listing-projects\"></a>\n\nTo list all available projects, use the `-o list` operation:\n```\nsubbud -o list\n```\n- `-o list`: Lists all available projects\n\n## Deleting Projects \u274c<a name=\"deleting-projects\"></a>\nTo delete a project and its associated subdomains, use the `-o delete `operation:\n\n```\nsubbud -p project_name -o delete\n```\n## Saving Merged Subdomains \ud83d\udcbe<a name=\"saving-merged-subdomains\"></a>\n\nTo save the merged subdomains to a text file on the current directory , use the `-o save` operation: \nit will save it with the current date and project name.\n\n\n```\nsubbud -p project_name -o save\n```\n## Requirements \u2699\ufe0f<a name=\"requirements\"></a>\n\n- Python 3.x\n- Redis Server (Make sure the Redis server is running) \ud83d\udee0\ufe0f\n\n## Contributing \ud83e\udd1d<a name=\"contributing\"></a>\nContributions to SubBud are welcome! If you have any suggestions, improvements, or bug fixes, please open an issue or create a pull request !\n\nInspired by [@jhaddix](https://github.com/jhaddix) \u2764\ufe0f Sir !\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A short description of the package",
"version": "0.0.2",
"project_urls": {
"Bug Tracker": "https://github.com/4riful/subbud/issues",
"Homepage": "https://github.com/4riful/subbud"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "21d7c08482374a9cc630a17c17e9947663057502420fcc021475d66cad3927a2",
"md5": "62e2c7e79b032ca992fd8c5b2257c676",
"sha256": "b098e9769e736da96bed6ca26e457524768378f42bd067cd368dbcdd27061edf"
},
"downloads": -1,
"filename": "subbud-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "62e2c7e79b032ca992fd8c5b2257c676",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4905,
"upload_time": "2024-07-16T18:58:52",
"upload_time_iso_8601": "2024-07-16T18:58:52.224545Z",
"url": "https://files.pythonhosted.org/packages/21/d7/c08482374a9cc630a17c17e9947663057502420fcc021475d66cad3927a2/subbud-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cfe155b4d3a9fa4e454d0241db048c5da707ec2d6bd568a0b25aeb2a1f139cfc",
"md5": "118697ce354ece104e329de78b7ddee5",
"sha256": "46b314224dada8fbf0554170cae669c198468d5de2e8cc49cdf3eaea603d21f7"
},
"downloads": -1,
"filename": "subbud-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "118697ce354ece104e329de78b7ddee5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4623,
"upload_time": "2024-07-16T18:58:53",
"upload_time_iso_8601": "2024-07-16T18:58:53.802310Z",
"url": "https://files.pythonhosted.org/packages/cf/e1/55b4d3a9fa4e454d0241db048c5da707ec2d6bd568a0b25aeb2a1f139cfc/subbud-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-16 18:58:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "4riful",
"github_project": "subbud",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "subbud"
}
