Palladiymateria / sharecheck

English · Русский 
 Scan your folder. Review your findings. Share with confidence. 
 A local CLI for spotting accidental secrets and preparing your project for GitHub.
 Quick start ·
 Commands ·
 Features ·
 Limitations 
---
**No account. No uploads. No third-party runtime dependencies.**
ShareCheck scans files on your computer and prints findings directly in your terminal: a path, line number, and suggested next step. Matched tokens and source lines are never printed. Your source files are not modified.
*Illustrative output from a sample project. Colors are part of the documentation artwork; the CLI itself prints plain text.*
## Quick start
Requires **Python 3.10 or newer**. Works on Windows, macOS, and Linux.
### 1. Download the project
With Git installed, open a terminal and clone the repository:
 [code] 
To check whether Git is installed, run `git --version`. If the command is not found, install Git from git-scm.com, then reopen your terminal.
Without Git, select **Code → Download ZIP** on the repository page, extract the archive, and open a terminal in the folder containing `pyproject.toml` and this README.
### 2. Check Python
 [code] 
On macOS and Linux, the command may be `python3`. If so, use it instead of `python` throughout these examples.
### 3. Run a scan
 [code] 
The dot means the current directory. To scan another project, provide its path:
 [code] 
 [code] 
Without installation, run these commands from the ShareCheck folder. To run from anywhere, install the command below.
### Install the `sharecheck` command
From the project folder:
 [code] 
Installation may download build tools. The scanner itself makes no network requests. If `sharecheck` is not found, use `python -m sharecheck` with the same Python interpreter you installed the package into.
 Install in a virtual environment 
Windows / PowerShell:
 [code] 
macOS / Linux:
 [code] 
These commands do not require activating the environment.
## Commands
| Task | Command |
| :--- | :--- |
| Scan the current directory | `python -m sharecheck .` |
| Scan another project | `python -m sharecheck "path/to/project"` |
| Print JSON | `python -m sharecheck . --json` |
| Save an HTML report | `python -m sharecheck . --html report.html` |
| Show help | `python -m sharecheck --help` |
Quote paths containing spaces. If you omit the folder argument, ShareCheck scans the current directory. Without installation, run commands from the ShareCheck folder.
### HTML reports
 [code] 
Open `report.html` in your browser to see findings, recommendations, and skipped-file counts. The report is standalone and needs no server. The output path is relative to your current directory. Existing files are never overwritten; choose a new filename instead.
### JSON for scripts
 [code] 
The result contains `root` (the project path), `stats` (scan counts), and `findings`. Each finding contains `severity`, `path`, `line`, `title`, and `advice`. The `line` field can be `null`.
## What it checks
| Check | Result |
| :--- |