sharkit 0.1.1.dev6__tar.gz → 0.1.2.dev1__tar.gz

sharkit-0.1.2.dev1/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.5
+Name: sharkit
+Version: 0.1.2.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/c027fb38-fe0f-4baa-b35f-597f9f8cf39b" /></div>
+
+<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.
+- Modules 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.
+- Ships with two example modules: `testing/demo/echo` and `testing/http/metadata`.
+- `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

sharkit-0.1.2.dev1/README.md

@@ -0,0 +1,63 @@
+<div align="center"><img width="640" height="347" alt="banner" src="https://github.com/user-attachments/assets/c027fb38-fe0f-4baa-b35f-597f9f8cf39b" /></div>
+
+<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.
+- Modules 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.
+- Ships with two example modules: `testing/demo/echo` and `testing/http/metadata`.
+- `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

{sharkit-0.1.1.dev6 → sharkit-0.1.2.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sharkit"
-version = "0.1.1.dev6"
+version = "0.1.2.dev1"
 description = "OSINT / HUMINT / GEOINT research framework"
 readme = "README.md"
 license = "MIT"

{sharkit-0.1.1.dev6 → sharkit-0.1.2.dev1}/src/sharkit/commands/builtins.py

@@ -110,19 +110,48 @@ class StatusCommand(Command):
 class UseCommand(Command):
     name = "use"
     aliases = []
-    description = "Select a module"
-    usage = "use <module_path>"
+    description = "Select a module by name, search query, or index (msfconsole-style)"
+    usage = "use <query|index>"
 
     def execute(self, context: CommandContext, args: list[str]) -> str | None:
         valid, error = self.validate_args(args)
         if not valid:
             return error
-        module_path = args[0]
+        token = args[0]
         module_registry = context.session.get("module_registry")
-        if module_registry is not None and module_registry.get_module(module_path) is None:
-            return f'Module "{module_path}" not found.\nTry: search {module_path}'
-        context.current_module = module_path
-        return f'Module "{module_path}" selected.'
+        if module_registry is None:
+            return "Module registry not available."
+
+        if token.isdigit():
+            matches = context.session.get("use_matches")
+            if not matches:
+                return 'No module selection in progress. Use "use <query>" to search first.'
+            index = int(token)
+            if index < 0 or index >= len(matches):
+                return f"Invalid module index: {index}"
+            context.current_module = matches[index]
+            return f'Module "{matches[index]}" selected.'
+
+        query = token.lower()
+        matches = module_registry.find_modules(query)
+        if not matches:
+            return f'No modules found matching "{token}".\nTry: search {token}'
+
+        paths = [path for path, _ in matches]
+        context.session["use_matches"] = paths
+
+        renderer = context.session.get("renderer")
+        if renderer is not None:
+            rows = [
+                [str(i), path, metadata.description]
+                for i, (path, metadata) in enumerate(matches)
+            ]
+            renderer.table(f"use > {token}", ["#", "Module", "Description"], rows)
+
+        if len(matches) == 1:
+            context.current_module = paths[0]
+            return f'Module "{paths[0]}" selected.'
+        return 'Select a module by index, e.g. "use 0".'
 
     def validate_args(self, args: list[str]) -> tuple[bool, str | None]:
         if not args:

{sharkit-0.1.1.dev6 → sharkit-0.1.2.dev1}/src/sharkit/modules/registry.py

@@ -42,6 +42,18 @@ class ModuleRegistry:
             or lower_query in module.metadata.description.lower()
         ]
 
+    def find_modules(self, query: str) -> list[tuple[str, ModuleMetadata]]:
+        lower_query = query.lower()
+        results: list[tuple[str, ModuleMetadata]] = []
+        for path, cls in self.get_all_modules().items():
+            metadata = cls.metadata
+            searchable = (
+                f"{metadata.name} {metadata.description} {metadata.category} {path}".lower()
+            )
+            if lower_query in searchable:
+                results.append((path, metadata))
+        return results
+
     def get_modules_by_category(self, category: str) -> list[ModuleMetadata]:
         lower_category = category.lower()
         return [

sharkit-0.1.1.dev6/PKG-INFO

@@ -1,124 +0,0 @@
-Metadata-Version: 2.5
-Name: sharkit
-Version: 0.1.1.dev6
-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
-
-# sharkit
-
-OSINT / HUMINT / GEOINT research framework — a modular CLI for gathering and correlating
-open-source intelligence from the terminal.
-
-> Built for Linux. Runs anywhere Python 3.11+ runs — including **Termux on Android**.
-
-## Requirements
-
-- Python >= 3.11
-- `pip` or `uv`
-
-## Installation
-
-From PyPI:
-
-```bash
-pip install sharkit
-```
-
-Or with `uv`:
-
-```bash
-uv tool install sharkit
-```
-
-Then launch the interactive shell:
-
-```bash
-sharkit
-```
-
-## Termux / Android
-
-sharkit is pure Python (no compiled extensions) and depends only on `prompt_toolkit`
-and `httpx`, so it installs and runs on Termux without any native build step.
-
-```bash
-pkg update && pkg install python
-pip install sharkit
-sharkit
-```
-
-If Termux's Python is marked *externally managed*, install into a virtual environment:
-
-```bash
-pkg install python
-python -m venv ~/sharkit-venv
-~/sharkit-venv/bin/pip install sharkit
-~/sharkit-venv/bin/sharkit
-```
-
-- Configuration, history and cache live under `~/.config/sharkit`
-  (on Android: `/data/data/com.termux/files/home/.config/sharkit`).
-- Network access uses the standard Termux permission — no extra setup required.
-- The UI relies on ANSI escape codes and Unicode box-drawing, which Termux's
-  terminal renders natively.
-
-## Quick start
-
-```
-sharkit                      # start the interactive shell
-help                        # list commands
-use testing/demo/echo       # load a module
-set message "hello"         # configure an option
-run                         # execute the active module
-history                     # show command history
-clear                       # clear the screen
-exit                        # quit
-```
-
-Available commands: `help`, `banner`, `version`, `status`, `use`, `back`, `info`,
-`show`, `set`, `unset`, `run`, `search`, `history`, `clear`, `exit`.
-
-## Modules
-
-Modules are discovered automatically from the packaged `sharkit/modules` directory:
-
-- `testing/demo/echo` — echo module for testing the framework
-- `testing/http/metadata` — HTTP metadata gathering (status, headers, content type, …)
-
-## Development
-
-```bash
-git clone https://github.com/sshsrv/sharkit
-cd sharkit
-uv sync --all-groups
-uv run sharkit
-```
-
-Quality gates: `uv run ruff check .`, `uv run mypy src/`, `uv run pytest -q`.
-
-## Disclaimer
-
-sharkit is a research tool. Use it responsibly and in accordance with applicable law
-and the terms of service of any system you interact with.

sharkit-0.1.1.dev6/README.md

@@ -1,96 +0,0 @@
-# sharkit
-
-OSINT / HUMINT / GEOINT research framework — a modular CLI for gathering and correlating
-open-source intelligence from the terminal.
-
-> Built for Linux. Runs anywhere Python 3.11+ runs — including **Termux on Android**.
-
-## Requirements
-
-- Python >= 3.11
-- `pip` or `uv`
-
-## Installation
-
-From PyPI:
-
-```bash
-pip install sharkit
-```
-
-Or with `uv`:
-
-```bash
-uv tool install sharkit
-```
-
-Then launch the interactive shell:
-
-```bash
-sharkit
-```
-
-## Termux / Android
-
-sharkit is pure Python (no compiled extensions) and depends only on `prompt_toolkit`
-and `httpx`, so it installs and runs on Termux without any native build step.
-
-```bash
-pkg update && pkg install python
-pip install sharkit
-sharkit
-```
-
-If Termux's Python is marked *externally managed*, install into a virtual environment:
-
-```bash
-pkg install python
-python -m venv ~/sharkit-venv
-~/sharkit-venv/bin/pip install sharkit
-~/sharkit-venv/bin/sharkit
-```
-
-- Configuration, history and cache live under `~/.config/sharkit`
-  (on Android: `/data/data/com.termux/files/home/.config/sharkit`).
-- Network access uses the standard Termux permission — no extra setup required.
-- The UI relies on ANSI escape codes and Unicode box-drawing, which Termux's
-  terminal renders natively.
-
-## Quick start
-
-```
-sharkit                      # start the interactive shell
-help                        # list commands
-use testing/demo/echo       # load a module
-set message "hello"         # configure an option
-run                         # execute the active module
-history                     # show command history
-clear                       # clear the screen
-exit                        # quit
-```
-
-Available commands: `help`, `banner`, `version`, `status`, `use`, `back`, `info`,
-`show`, `set`, `unset`, `run`, `search`, `history`, `clear`, `exit`.
-
-## Modules
-
-Modules are discovered automatically from the packaged `sharkit/modules` directory:
-
-- `testing/demo/echo` — echo module for testing the framework
-- `testing/http/metadata` — HTTP metadata gathering (status, headers, content type, …)
-
-## Development
-
-```bash
-git clone https://github.com/sshsrv/sharkit
-cd sharkit
-uv sync --all-groups
-uv run sharkit
-```
-
-Quality gates: `uv run ruff check .`, `uv run mypy src/`, `uv run pytest -q`.
-
-## Disclaimer
-
-sharkit is a research tool. Use it responsibly and in accordance with applicable law
-and the terms of service of any system you interact with.