<p align="center">
<a href="https://github.com/pablosnt/rekono-cli/actions/workflows/unit-testing.yml" alt="Unit testing" target="_blank">
<img src="https://github.com/pablosnt/rekono-cli/actions/workflows/unit-testing.yml/badge.svg"/>
</a>
<a href="https://github.com/pablosnt/rekono-cli/actions/workflows/security-sast.yml" alt="SAST" target="_blank">
<img src="https://github.com/pablosnt/rekono-cli/actions/workflows/security-sast.yml/badge.svg"/>
</a>
<a href="https://snyk.io/test/github/pablosnt/rekono-cli" alt="SCA" target="_blank">
<img src="https://badgen.net/snyk/pablosnt/rekono-cli?label=SCA&labelColor=black&icon=https://snyk.io/wp-content/uploads/patch-white.svg"/>
</a>
<a href="https://github.com/pablosnt/rekono-cli/actions/workflows/security-secrets.yml" alt="Secrets scanning" target="_blank">
<img src="https://github.com/pablosnt/rekono-cli/actions/workflows/security-secrets.yml/badge.svg"/>
</a>
<a href="https://github.com/pablosnt/rekono-cli/actions/workflows/code-style.yml" alt="Code style" target="_blank">
<img src="https://github.com/pablosnt/rekono-cli/actions/workflows/code-style.yml/badge.svg"/>
</a>
<a href="https://discord.gg/Zyduu5C7M3" target="_blank">
<img src="https://img.shields.io/badge/Discord-Join-black?style=social&logo=discord"/>
</a>
<a href="https://ko-fi.com/pablosnt" target="_blank">
<img src="https://ko-fi.com/img/githubbutton_sm.svg" width="160"/>
</a>
<a href="https://www.buymeacoffee.com/pablosnt" target="_blank">
<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="75"/>
</a>
</p>
# <p align="center"><img src="https://raw.githubusercontent.com/pablosnt/rekono/main/rekono/frontend/public/static/logo-black.png" width="500"/></p>
Command Line Interface to make requests to the [Rekono](https://github.com/pablosnt/rekono) API REST.
## Usage
<img width="507" alt="usage" src="https://user-images.githubusercontent.com/69458381/224380037-19638197-75dc-457c-b5aa-7dcc1f9d1a4d.png">
> Rekono API documentation is available in `/api/schema/swagger-ui.html` and `/api/schema/redoc/` of Rekono instances
## Library usage
Rekono CLI can be also used as Python 3 library, so that it's possible to create custom Rekono scripts. For example, with the following code it's possible to create a Rekono client to make custom API requests:
```python
from rekono.client.api import Rekono
client = Rekono(url='https://127.0.0.1', token='my secret api token') # Create Rekono client
response = client.get('/api/tools/1/') # GET request to get tool with ID 1
```
## Installation
### PIP
```bash
pip3 install rekono-cli
```
### From Source
1. Install the required technologies: Python 3 & PIP
2. Install the dependencies:
```bash
pip3 install -r src/requirements.txt
```
3. Execute the CLI:
```bash
python3 src/rekono/main.py --help
```
## Configuration
You can use the `REKONO_TOKEN` environment variable to configure the API token for Rekono authentication.
## Reach Us
You can get support, ask questions, solve doubts or solve problems using:
<p>
<a href="https://github.com/pablosnt/rekono/issues/new?labels=help+wanted%2C+question&template=support.md" alt="GitHub Issue">
<img src="https://github.com/fluidicon.png" width="64"/>
</a>
<a href="https://discord.gg/Zyduu5C7M3" alt="Discord">
<img src="https://assets-global.website-files.com/6257adef93867e50d84d30e2/636e0a69f118df70ad7828d4_icon_clyde_blurple_RGB.svg" width="64"/>
</a>
<a href="mailto:rekono.project@gmail.com" alt="Mail">
<img src="https://www.gstatic.com/images/branding/product/2x/gmail_2020q4_512dp.png" width="64"/>
</a>
</p>
Rekono is an open source project that we really love to maintain and it's absolutely our pleasure, but we would like to offer the possibility of supporting Rekono's development via donations. At the moment, the project only needs its maintainer's time to stay up to date with new features and fix bugs. However, in the future, it could need more expensive resources like hosting, new web pages for documentation, the inclusion of premium hacking tools, etc. With the help received from our supporters, Rekono will be able to grow fastly and have the resources that it deserves. Of course, you can use the donations just to appreciate our work. Thank you for your help!
<p>
<a href="https://ko-fi.com/pablosnt" target="_blank">
<img src="https://storage.ko-fi.com/cdn/brandasset/kofi_s_tag_white.png" width="130"/>
</a>
<a href="https://www.buymeacoffee.com/pablosnt" target="_blank">
<img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=pablosnt&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff"/>
</a>
</p>
> The main differences between them are that BuyMeACoffe charges fees over each donation while Ko-fi doesn't and Ko-fi supports PayPal payments while BuyMeACoffe doesn't
## License
Rekono is licensed under the [GNU GENERAL PUBLIC LICENSE Version 3](../LICENSE.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/pablosnt/rekono-cli",
"name": "rekono-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "automation,pentesting,security,cli,rekono",
"author": "Pablo Santiago L\u00f3pez",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/d2/d9/746e0ec84601fd2e8fa62eb830cad771e16d94c0bed1ba7e9aa575265daa/rekono-cli-2.0.1.post1.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://github.com/pablosnt/rekono-cli/actions/workflows/unit-testing.yml\" alt=\"Unit testing\" target=\"_blank\">\n <img src=\"https://github.com/pablosnt/rekono-cli/actions/workflows/unit-testing.yml/badge.svg\"/>\n </a>\n <a href=\"https://github.com/pablosnt/rekono-cli/actions/workflows/security-sast.yml\" alt=\"SAST\" target=\"_blank\">\n <img src=\"https://github.com/pablosnt/rekono-cli/actions/workflows/security-sast.yml/badge.svg\"/>\n </a>\n <a href=\"https://snyk.io/test/github/pablosnt/rekono-cli\" alt=\"SCA\" target=\"_blank\">\n <img src=\"https://badgen.net/snyk/pablosnt/rekono-cli?label=SCA&labelColor=black&icon=https://snyk.io/wp-content/uploads/patch-white.svg\"/>\n </a>\n <a href=\"https://github.com/pablosnt/rekono-cli/actions/workflows/security-secrets.yml\" alt=\"Secrets scanning\" target=\"_blank\">\n <img src=\"https://github.com/pablosnt/rekono-cli/actions/workflows/security-secrets.yml/badge.svg\"/>\n </a>\n <a href=\"https://github.com/pablosnt/rekono-cli/actions/workflows/code-style.yml\" alt=\"Code style\" target=\"_blank\">\n <img src=\"https://github.com/pablosnt/rekono-cli/actions/workflows/code-style.yml/badge.svg\"/>\n </a>\n <a href=\"https://discord.gg/Zyduu5C7M3\" target=\"_blank\">\n <img src=\"https://img.shields.io/badge/Discord-Join-black?style=social&logo=discord\"/>\n </a>\n <a href=\"https://ko-fi.com/pablosnt\" target=\"_blank\">\n <img src=\"https://ko-fi.com/img/githubbutton_sm.svg\" width=\"160\"/>\n </a>\n <a href=\"https://www.buymeacoffee.com/pablosnt\" target=\"_blank\">\n <img src=\"https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png\" alt=\"Buy Me A Coffee\" width=\"75\"/>\n </a>\n</p>\n\n# <p align=\"center\"><img src=\"https://raw.githubusercontent.com/pablosnt/rekono/main/rekono/frontend/public/static/logo-black.png\" width=\"500\"/></p>\n\nCommand Line Interface to make requests to the [Rekono](https://github.com/pablosnt/rekono) API REST.\n\n\n## Usage\n\n<img width=\"507\" alt=\"usage\" src=\"https://user-images.githubusercontent.com/69458381/224380037-19638197-75dc-457c-b5aa-7dcc1f9d1a4d.png\">\n\n> Rekono API documentation is available in `/api/schema/swagger-ui.html` and `/api/schema/redoc/` of Rekono instances\n\n## Library usage\n\nRekono CLI can be also used as Python 3 library, so that it's possible to create custom Rekono scripts. For example, with the following code it's possible to create a Rekono client to make custom API requests:\n\n```python\nfrom rekono.client.api import Rekono\nclient = Rekono(url='https://127.0.0.1', token='my secret api token') # Create Rekono client\nresponse = client.get('/api/tools/1/') # GET request to get tool with ID 1\n```\n\n\n## Installation\n\n### PIP\n\n```bash\npip3 install rekono-cli\n```\n\n### From Source\n\n1. Install the required technologies: Python 3 & PIP\n\n2. Install the dependencies:\n\n ```bash\n pip3 install -r src/requirements.txt\n ```\n\n3. Execute the CLI:\n\n ```bash\n python3 src/rekono/main.py --help\n ```\n\n\n## Configuration\n\nYou can use the `REKONO_TOKEN` environment variable to configure the API token for Rekono authentication.\n\n\n## Reach Us\n\nYou can get support, ask questions, solve doubts or solve problems using:\n\n<p>\n <a href=\"https://github.com/pablosnt/rekono/issues/new?labels=help+wanted%2C+question&template=support.md\" alt=\"GitHub Issue\">\n <img src=\"https://github.com/fluidicon.png\" width=\"64\"/>\n </a>\n <a href=\"https://discord.gg/Zyduu5C7M3\" alt=\"Discord\">\n <img src=\"https://assets-global.website-files.com/6257adef93867e50d84d30e2/636e0a69f118df70ad7828d4_icon_clyde_blurple_RGB.svg\" width=\"64\"/>\n </a>\n <a href=\"mailto:rekono.project@gmail.com\" alt=\"Mail\">\n <img src=\"https://www.gstatic.com/images/branding/product/2x/gmail_2020q4_512dp.png\" width=\"64\"/>\n </a>\n</p>\n\nRekono is an open source project that we really love to maintain and it's absolutely our pleasure, but we would like to offer the possibility of supporting Rekono's development via donations. At the moment, the project only needs its maintainer's time to stay up to date with new features and fix bugs. However, in the future, it could need more expensive resources like hosting, new web pages for documentation, the inclusion of premium hacking tools, etc. With the help received from our supporters, Rekono will be able to grow fastly and have the resources that it deserves. Of course, you can use the donations just to appreciate our work. Thank you for your help!\n\n<p>\n <a href=\"https://ko-fi.com/pablosnt\" target=\"_blank\">\n <img src=\"https://storage.ko-fi.com/cdn/brandasset/kofi_s_tag_white.png\" width=\"130\"/>\n </a>\n <a href=\"https://www.buymeacoffee.com/pablosnt\" target=\"_blank\">\n <img src=\"https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=pablosnt&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff\"/>\n </a>\n</p>\n\n> The main differences between them are that BuyMeACoffe charges fees over each donation while Ko-fi doesn't and Ko-fi supports PayPal payments while BuyMeACoffe doesn't\n\n\n## License\n\nRekono is licensed under the [GNU GENERAL PUBLIC LICENSE Version 3](../LICENSE.md)",
"bugtrack_url": null,
"license": "",
"summary": "CLI to make requests to Rekono API",
"version": "2.0.1.post1",
"project_urls": {
"Homepage": "https://github.com/pablosnt/rekono-cli",
"Rekono": "https://github.com/pablosnt/rekono",
"Rekono CLI": "https://github.com/pablosnt/rekono-cli"
},
"split_keywords": [
"automation",
"pentesting",
"security",
"cli",
"rekono"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d2d9746e0ec84601fd2e8fa62eb830cad771e16d94c0bed1ba7e9aa575265daa",
"md5": "23b0be9b64e2e5d1c353c4536def0d35",
"sha256": "ac32efa3e77dfc5c826bc580c49afe9a97c5be7f9da9a62fe9a734fc546abe79"
},
"downloads": -1,
"filename": "rekono-cli-2.0.1.post1.tar.gz",
"has_sig": false,
"md5_digest": "23b0be9b64e2e5d1c353c4536def0d35",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 17579,
"upload_time": "2023-05-31T17:21:08",
"upload_time_iso_8601": "2023-05-31T17:21:08.267562Z",
"url": "https://files.pythonhosted.org/packages/d2/d9/746e0ec84601fd2e8fa62eb830cad771e16d94c0bed1ba7e9aa575265daa/rekono-cli-2.0.1.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-31 17:21:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pablosnt",
"github_project": "rekono-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "rekono-cli"
}
JSON
