securezy-cli 0.1.1

Lightweight security utility CLI (port scan, vault, crypto, hashing, reports, plugins).

Securezy CLI (securezy-cli)

Securezy CLI is a lightweight, pip-installable Python toolkit for common security tasks: fast port scanning, encrypted vault storage, file encryption, hashing, reporting, and plugins.

PyPI: securezy-cli (CLI command: securezy)

Install (recommended)

Install from PyPI (recommended: use a virtualenv):

py -m venv .venv
.\.venv\Scripts\python -m pip install -U pip
.\.venv\Scripts\python -m pip install "securezy-cli[crypto,vault]"
.\.venv\Scripts\securezy --help

For local development (editable):

py -m venv .venv
.\.venv\Scripts\python -m pip install -U pip
.\.venv\Scripts\python -m pip install -e ".[dev,crypto,vault]"
.\.venv\Scripts\securezy --help

CLI quickstart

Show commands:

.\.venv\Scripts\securezy --help

Fast port scanning

.\.venv\Scripts\securezy scan ports -t 127.0.0.1 -p 1-1024
.\.venv\Scripts\securezy scan ports -t 127.0.0.1 -p 22,80,443 --timeout 0.8 --concurrency 800
.\.venv\Scripts\securezy scan ports -t 127.0.0.1 -p 1-1024 --json

Scan reporting/export (JSON/CSV/Markdown)

Single report file:

.\.venv\Scripts\securezy scan ports -t 127.0.0.1 -p 1-1024 --report .\report.json --report-format json
.\.venv\Scripts\securezy scan ports -t 127.0.0.1 -p 1-1024 --report .\report.md --report-format md
.\.venv\Scripts\securezy scan ports -t 127.0.0.1 -p 1-1024 --report .\report.csv --report-format csv

Report bundle directory:

.\.venv\Scripts\securezy scan ports -t 127.0.0.1 -p 1-1024 --report-dir .\reports --report-formats json,md,csv

Profiles (saved scan configs)

Create and use a profile:

.\.venv\Scripts\securezy profiles set local -t 127.0.0.1 -p 1-1024 --timeout 0.5 --concurrency 500
.\.venv\Scripts\securezy profiles list
.\.venv\Scripts\securezy scan ports --profile local

Show where profiles are stored:

.\.venv\Scripts\securezy profiles path

To store profiles in a custom location (useful for CI/tests):

$env:SECUREZY_HOME = "C:\\temp\\securezy"

Plugins

List and run plugins:

.\.venv\Scripts\securezy plugins list
.\.venv\Scripts\securezy plugins run hello "hello from plugin"

Plugins are discovered via Python entrypoints group securezy.plugins.

Generate a new plugin skeleton:

.\.venv\Scripts\securezy plugins scaffold my-plugin -o .

Then install it:

cd .\securezy-plugin-my-plugin
py -m venv .venv
.\.venv\Scripts\python -m pip install -U pip
.\.venv\Scripts\python -m pip install -e .

And verify it shows up:

.\.venv\Scripts\securezy plugins list
.\.venv\Scripts\securezy plugins run my-plugin "it works"

Vault (encrypted credential storage)

.\.venv\Scripts\securezy vault init
.\.venv\Scripts\securezy vault add github -u akash
.\.venv\Scripts\securezy vault get github --show-password
.\.venv\Scripts\securezy vault list

Crypto (file encryption/decryption)

.\.venv\Scripts\securezy crypto encrypt -i secret.txt -o secret.txt.sz
.\.venv\Scripts\securezy crypto decrypt -i secret.txt.sz -o secret.txt

Hashing + verify

.\.venv\Scripts\securezy hash text --algo sha256 "hello"
.\.venv\Scripts\securezy hash file --algo sha256 .\somefile.iso
.\.venv\Scripts\securezy hash verify --algo sha256 --hash <expected> --file .\somefile.iso

Development

.\.venv\Scripts\python -m ruff check securezy tests
.\.venv\Scripts\python -m pytest -q

Publishing (TestPyPI / PyPI)

This repo includes a GitHub Actions workflow at .github/workflows/release.yml.

Required GitHub secrets

Create these secrets in your GitHub repo settings:

• PYPI_API_TOKEN
• TEST_PYPI_API_TOKEN

Publish to TestPyPI (recommended first)

Use GitHub Actions Release workflow → Run workflow → choose testpypi.

Publish to PyPI

Option A (recommended): push a tag like v0.1.0:

git tag v0.1.0
git push origin v0.1.0

Option B: run the GitHub Actions workflow manually and choose pypi.