Secret Scanner Installation

Installation

Install the ByteHide Secret Scanner using pip:

pip install bytehide-secrets-scanner

pip install bytehide-secrets-scanner

Basic Setup

After installation, initialize the scanner configuration:

bytehide-secrets init

bytehide-secrets init

This interactive command will create a bytehide.secrets.json file in your project root directory:

{
  "token": "<your-project-token>",
  "appName": "My Python Project",
  "environment": "development",
  "sync": true,
  "fix": false,
  "anonymize": false
}

{
  "token": "<your-project-token>",
  "appName": "My Python Project",
  "environment": "development",
  "sync": true,
  "fix": false,
  "anonymize": false
}

Verify Installation

After installation, run a scan to verify everything is working:

bytehide-secrets scan

bytehide-secrets scan

The scanner will automatically:

1. Check if scanning is enabled for your configuration
2. Scan source code for secrets
3. Report any findings to your ByteHide dashboard
4. Export detected secrets to your ByteHide Secrets Manager (if configured)

Build Integration

For automatic scanning, you can add the scanner to your build or test pipeline:

Using a Makefile

.PHONY: scan-secrets
scan-secrets:
	bytehide-secrets scan .

.PHONY: test
test: scan-secrets
	pytest tests/

.PHONY: scan-secrets
scan-secrets:
	bytehide-secrets scan .

.PHONY: test
test: scan-secrets
	pytest tests/

Using setup.cfg or pyproject.toml

Add a custom script entry to run the scanner before tests:

# pyproject.toml
[tool.pytest.ini_options]
# Run scanner as part of your test suite

# pyproject.toml
[tool.pytest.ini_options]
# Run scanner as part of your test suite

bytehide-secrets scan && pytest tests/

bytehide-secrets scan && pytest tests/

Scanner Workflow

The Secret Scanner integrates into your development workflow:

1. Installation: Install the pip package
2. Configuration: Set up the scanner via the JSON file or init command
3. Scanning: Run manually or automatically during builds
4. Reporting: Detected secrets appear in your ByteHide dashboard
5. Action: Export, fix, or receive alerts about found secrets

What's Next?

• Configure scanner options
• Set up GitHub integration
• Integrate with CI/CD pipelines
• View detected secrets