Metadata-Version: 2.5
Name: sharkit
Version: 1.0.1.dev1
Summary: OSINT / HUMINT / GEOINT research framework
Project-URL: Homepage, https://github.com/sshsrv/sharkit
Project-URL: Repository, https://github.com/sshsrv/sharkit
Project-URL: Issues, https://github.com/sshsrv/sharkit/issues
Author: Sharkit Contributors
License-Expression: MIT
License-File: LICENSE
Keywords: cli,framework,geoint,humint,osint,research
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Security
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Requires-Dist: httpx<1.0.0,>=0.27.0
Requires-Dist: prompt-toolkit<4.0.0,>=3.0.0
Description-Content-Type: text/markdown

<div align="center"><img width="640" height="347" alt="banner" src="https://github.com/user-attachments/assets/6bff669d-78f7-430f-88f7-49fefa832128" /></div>
<br>
<div align="center">
  
![PyPI](https://img.shields.io/pypi/v/sharkit?labelColor=000000&color=ff5faf&style=flat)
![Python](https://img.shields.io/pypi/pyversions/sharkit?labelColor=000000&color=ff5faf&style=flat)
![License](https://img.shields.io/pypi/l/sharkit?labelColor=000000&color=ff5faf&style=flat)
![CI](https://img.shields.io/github/actions/workflow/status/sshsrv/sharkit/ci.yml?labelColor=000000&color=ff5faf&style=flat)

</div>

> [!IMPORTANT]  
> sharkit is intended for lawful OSINT research, authorized security testing, education, and legitimate investigations. You are responsible for complying with applicable laws, permissions, and terms of service.
> 
> sharkit does not guarantee anonymity.
#

### Features
- A terminal framework for OSINT / HUMINT / GEOINT work.
- Tools expose a `run` method, options, and metadata; the shell loads them as you need them.
- 15 built-in commands: `use`, `run`, `set`, `search`, `history`, `clear`, `exit`, and a few more.
- Tools are discovered automatically from `src/sharkit/tools/`.
- `sharkit --version` shows the exact build you have, dev pre-releases included.
- State lives in `~/.config/sharkit` and runs fine on Termux / Android.
- To wipe it completely: `uv tool uninstall sharkit` and `rm -rf ~/.config/sharkit`.
#

### sharkit management on Linux using uv (RECOMMENDED)
- Install
```bash
uv tool install sharkit
```
- Upgrade
```bash
uv tool upgrade sharkit
```
- Uninstall
```bash
uv tool uninstall sharkit
rm -rf ~/.config/sharkit
```
<br>

### sharkit management on Linux using pip
- Install
```bash
pip install sharkit
```
- Upgrade
```bash
pip install --upgrade sharkit
```
- Uninstall
```bash
pip uninstall sharkit
rm -rf ~/.config/sharkit
```
#

### Links
- PyPI: https://pypi.org/project/sharkit/
- GitHub: https://github.com/sshsrv/sharkit
- Releases: https://github.com/sshsrv/sharkit/releases