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

documentation update #241

Open
wants to merge 3 commits into
base: main
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
2 changes: 1 addition & 1 deletion .pyup.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
schedule: "every month"
update: "all"
assignees:
- mBouamama
- tyki6
label_prs: update
79 changes: 48 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
# rawsec_cli
[![mBouamama](https://github.com/mBouamama/rawsec_cli/workflows/Unit%20Test/badge.svg)](https://github.com/mBouamama/rawsec_cli)

[![tyki6](https://github.com/tyki6/rawsec_cli/workflows/Unit%20Test/badge.svg)](https://github.com/tyki6/rawsec_cli)
[![PyPI](https://img.shields.io/pypi/v/rawsec-cli)](https://pypi.org/project/rawsec-cli/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rawsec-cli)](https://pypi.org/project/rawsec-cli/)
[![PyPI - Download](https://pepy.tech/badge/rawsec-cli)](https://pepy.tech/project/rawsec-cli)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/mBouamama/rawsec_cli)](https://github.com/mBouamama/rawsec_cli/releases)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/tyki6/rawsec_cli)](https://github.com/tyki6/rawsec_cli/releases)
[![Documentation Status](https://readthedocs.org/projects/rawsec_cli/badge/?version=latest)](https://rawsec_cli.readthedocs.io/en/latest/?badge=latest)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/mBouamama/rawsec_cli)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/tyki6/rawsec_cli)
[![docstr_coverage](./img/docstr_coverage_badge.svg)](https://github.com/HunterMcGushion/docstr_coverage.git)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/mBouamama/rawsec_cli/main.svg)](https://results.pre-commit.ci/latest/github/mBouamama/rawsec_cli/main)
[![codecov](https://codecov.io/gh/mBouamama/rawsec_cli/branch/main/graph/badge.svg?token=YKclZIzF6Z)](https://codecov.io/gh/mBouamama/rawsec_cli)
[![Updates](https://pyup.io/repos/github/mBouamama/rawsec_cli/shield.svg)](https://pyup.io/repos/github/mBouamama/rawsec_cli/)
[![Known Vulnerabilities](https://snyk.io/test/github/mBouamama/rawsec_cli/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/mBouamama/rawsec_cli?targetFile=requirements.txt)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/tyki6/rawsec_cli/main.svg)](https://results.pre-commit.ci/latest/github/tyki6/rawsec_cli/main)
[![codecov](https://codecov.io/gh/tyki6/rawsec_cli/branch/main/graph/badge.svg?token=YKclZIzF6Z)](https://codecov.io/gh/tyki6/rawsec_cli)
[![Updates](https://pyup.io/repos/github/tyki6/rawsec_cli/shield.svg)](https://pyup.io/repos/github/tyki6/rawsec_cli/)
[![Known Vulnerabilities](https://snyk.io/test/github/tyki6/rawsec_cli/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/tyki6/rawsec_cli?targetFile=requirements.txt)
[![Rawsec's CyberSecurity Inventory](https://inventory.raw.pm/img/badges/Rawsec-inventoried-FF5050_flat.svg)](https://inventory.raw.pm/tools.html#rawsec_cli)

# Introduction

[Rawsec's Cybersecurity](https://inventory.raw.pm/overview.html) Inventory is an inventory with 4 category(Tools, Resources, Ctf Platforms, OS).
This cli can search a project,list all projects by category, you can filter your research with option --help for more information.

# Table of Contents

- [Features](#features)
- [RoadMap](#roadmap)
- [Installation](#installation)
Expand Down Expand Up @@ -46,28 +49,28 @@ This cli can search a project,list all projects by category, you can filter your

To install rawsec-cli, simply use pip:

```
```bash
pip install rawsec-cli
```

To run rawsec-cli from a docker image, run:

```
docker run -it docker.pkg.github.com/mbouamama/rawsec_cli/rawsec-cli:latest rawsec-cli --help
```bash
docker run -it docker.pkg.github.com/tyki6/rawsec_cli/rawsec-cli:latest rawsec-cli --help
```

To install rawsec-cli, on git:

```
git clone https://github.com/mBouamama/rawsec_cli.git
```bash
git clone https://github.com/tyki6/rawsec_cli.git
cd ./rawsec_cli
pip install -r requirements.txt
python setup.py install
```

To install rawsec-cli on BlackArch:

```
```bash
pacman -S rawsec-cli
```

Expand All @@ -84,13 +87,13 @@ If your research containing only 1 Result, rawsec will open a new brower tab red

You can search by key word, you will see all projects with jwt in their description or name:

```
```bash
rawsec-cli search jwt
```

You can search a project, if the Search containing 1 result you will see result in console, and a tab is opened on your browser with redirect to website if informed or source:

```
```bash
rawsec-cli search myjwt
```

Expand All @@ -117,20 +120,24 @@ You can list all tools by tool's category.

```
Category available:
adversary_simulation
binary_exploitation
bug_bounty
cloud
code_analysis
collaboration_report
collaboration_and_report
configuration_audit
cracking
crisis_management
cryptography
defensive
digital_forensics
honeypot_decoy
hardware
honeypot_and_decoy
incident_response
intentionally_vulnerable_applications
networking
osint
osint_and_reconnaissance
other
plugins
red_teaming
Expand All @@ -147,13 +154,13 @@ Category available:

List all tools:

```
```bash
rawsec-cli list tools
```

List all [binary exploitation tools](#toolss-category):

```
```bash
rawsec-cli list tools binary_exploitation
```

Expand All @@ -165,11 +172,11 @@ You can list all tools by Resources's category.

```
Category available:
bug_bounty_and_disclosure_platforms
bug_bounty_pentest_and_disclosure_platforms
challenges_platforms
cve
events
information
information_news_blog
knowledge_and_tools
national_security_agencies_and_services
non_english
Expand All @@ -182,13 +189,13 @@ Category available:

List all resources:

```
```bash
rawsec-cli list resources
```

List all [events resources](#resourcess-category):

```
```bash
rawsec-cli list resources events
```

Expand All @@ -209,12 +216,13 @@ Category available:

List all ctf:

```
```bash
rawsec-cli list ctf
```

List all [attack_defense ctf](#ctfs-category):
```

```bash
rawsec-cli list ctf attack_defense
```

Expand All @@ -235,23 +243,27 @@ Category available:

List all os:

```
```bash
rawsec-cli list os
```

List all [maintained os](#oss-category):
```

```bash
rawsec-cli list os maintained
```

## Options

## rawsec-cli

| command | type | description |
| ------------------ | -------------- | ---------------------------------------------------------|
| -V, --version | None | show version. |
| -h, --help | None | Show help message and exit. |

## search

| command | type | description |
| ------------------ | -------------- | ---------------------------------------------------------|
| -l, --lang | language | Filter by Language |
Expand All @@ -265,7 +277,9 @@ rawsec-cli list os maintained
| -h, --help | None | Show search help message and exit. |

## list

### tools

| command | type | description |
| ------------------ | -------------- | ---------------------------------------------------------|
| -l, --lang | language | Filter by Language |
Expand All @@ -279,6 +293,7 @@ rawsec-cli list os maintained
| -h, --help | None | Show list tools help message and exit. |

### resources

| command | type | description |
| ------------------ | -------------- | ---------------------------------------------------------|
| -p, --paid | None | Filter by Price, when price is equal to paid |
Expand All @@ -288,6 +303,7 @@ rawsec-cli list os maintained
| -h, --help | None | Show list resources help message and exit. |

### ctf

| command | type | description |
| ------------------ | -------------- | ---------------------------------------------------------|
| -l, --lang | language | Filter by Language |
Expand All @@ -298,6 +314,7 @@ rawsec-cli list os maintained
| -h, --help | None | Show list ctf help message and exit. |

### os

| command | type | description |
| ------------------ | -------------- | ---------------------------------------------------------|
| -b, --base | Text | Filter by base(ex: Linux) |
Expand All @@ -307,11 +324,11 @@ rawsec-cli list os maintained

# Download

Check github releases. Latest is available at https://github.com/mBouamama/rawsec_cli/releases/latest
Check github releases. Latest is available at https://github.com/tyki6/rawsec_cli/releases/latest

# Thanks

See [THANKS.md](https://github.com/mBouamama/rawsec_cli/blob/master/THANKS.md).
See [THANKS.md](https://github.com/tyki6/rawsec_cli/blob/master/THANKS.md).

# Contribute

Expand All @@ -327,4 +344,4 @@ I will check as Soon as Possible.

The log's become rather long. It moved to its own file.

See [CHANGES](https://github.com/mBouamama/rawsec_cli/blob/master/CHANGELOG.md).
See [CHANGES](https://github.com/tyki6/rawsec_cli/blob/master/CHANGELOG.md).
15 changes: 15 additions & 0 deletions docs/source/changelog.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,40 @@
# Changelog

All notable changes to this project will be documented in this file.

## [1.2.0] - 05-07-2021

### Changed

- architecture change #203
- new package

### Added

- better output
- color output
- list output

## [1.1.1] - 19-12-2020

### Changed

- docker img

## [1.1.0] - 19-12-2020

### Added

- Output format: json, csv, txt
- output format option
- output-file option
- readthedocs
- category list
- pull_request templates
- new table display

### Changed

- CI/CD
- CODE_OF_CONDUCT
- codecov conf
Expand All @@ -31,7 +44,9 @@ All notable changes to this project will be documented in this file.
- api doc

## [1.0.0] - 08-12-2020

### Added

- search
- list
- documentation
Expand Down
24 changes: 12 additions & 12 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,36 +5,36 @@

Rawsec Cli
=================================
.. image:: https://github.com/mBouamama/rawsec_cli/workflows/Unit%20Test/badge.svg
:target: https://github.com/mBouamama/rawsec_cli
.. image:: https://github.com/tyki6/rawsec_cli/workflows/Unit%20Test/badge.svg
:target: https://github.com/tyki6/rawsec_cli

.. image:: https://img.shields.io/pypi/v/rawsec-cli
:target: https://pypi.org/project/rawsec-cli/

.. image:: https://img.shields.io/pypi/pyversions/rawsec-cli.svg
:target: https://pypi.org/project/rawsec-cli/

.. image:: https://results.pre-commit.ci/badge/github/mBouamama/rawsec_cli/main.svg
:target: https://results.pre-commit.ci/latest/github/mBouamama/rawsec_cli/main
.. image:: https://results.pre-commit.ci/badge/github/tyki6/rawsec_cli/main.svg
:target: https://results.pre-commit.ci/latest/github/tyki6/rawsec_cli/main
:alt: pre-commit.ci status

.. image:: https://pepy.tech/badge/rawsec-cli
:target: https://pepy.tech/project/rawsec-cli

.. image:: https://pyup.io/repos/github/mBouamama/rawsec_cli/shield.svg
:target: https://pyup.io/repos/github/mBouamama/rawsec_cli/
.. image:: https://pyup.io/repos/github/tyki6/rawsec_cli/shield.svg
:target: https://pyup.io/repos/github/tyki6/rawsec_cli/

.. image:: https://img.shields.io/pypi/l/rawsec-cli.svg
:target: https://pypi.org/project/rawsec-cli/

.. image:: https://codecov.io/gh/mBouamama/rawsec_cli/branch/main/graph/badge.svg?token=YKclZIzF6Z
:target: https://codecov.io/gh/mBouamama/rawsec_cli
.. image:: https://codecov.io/gh/tyki6/rawsec_cli/branch/main/graph/badge.svg?token=YKclZIzF6Z
:target: https://codecov.io/gh/tyki6/rawsec_cli

.. image:: /../../img/docstr_coverage_badge.svg
:target: https://github.com/HunterMcGushion/docstr_coverage.git

.. image:: https://snyk.io/test/github/mBouamama/rawsec_cli/badge.svg?targetFile=requirements.txt
:target: https://snyk.io/test/github/mBouamama/rawsec_cli?targetFile=requirements.txt
.. image:: https://snyk.io/test/github/tyki6/rawsec_cli/badge.svg?targetFile=requirements.txt
:target: https://snyk.io/test/github/tyki6/rawsec_cli?targetFile=requirements.txt

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
Expand All @@ -49,8 +49,8 @@ This cli can search a project,list all projects by category, you can filter your
Getting help
--------

If the Documentation doesn’t answer your question, you can discuss rawsec-cli or get help using it on `Rawsec-cli's repository discussion <https://github.com/mBouamama/rawsec_cli/discussions>`_.
Bug reports are gladly accepted at the `GitHub issue tracker <https://github.com/mBouamama/rawsec_cli/issues>`_. GitHub also hosts the `code repository <https://github.com/mBouamama/rawsec_cli>`_.
If the Documentation doesn’t answer your question, you can discuss rawsec-cli or get help using it on `Rawsec-cli's repository discussion <https://github.com/tyki6/rawsec_cli/discussions>`_.
Bug reports are gladly accepted at the `GitHub issue tracker <https://github.com/tyki6/rawsec_cli/issues>`_. GitHub also hosts the `code repository <https://github.com/tyki6/rawsec_cli>`_.


More information
Expand Down
Loading
Loading