Safeguard CLI
Safeguard CLI
Command-line interface for Safeguard.sh software supply chain security
Safeguard CLI
The Safeguard CLI provides command-line access to all Safeguard.sh capabilities, enabling automation, CI/CD integration, and local development workflows.
Overview
The CLI allows you to:
- Generate SBOMs from local projects
- Scan for vulnerabilities
- Enforce security policies and gates
- Upload and manage SBOMs
- Integrate with CI/CD pipelines
- Automate security workflows
Quick Start
# Install the CLI
npm install -g @safeguard-sh/cli
# Authenticate
safeguard auth login
# Generate your first SBOM
safeguard sbom generate --source .
# Check for vulnerabilities
safeguard scan --source .Key Features
| Feature | Description |
|---|---|
| SBOM Generation | Create SBOMs from source code, containers, and binaries |
| Vulnerability Scanning | Identify security issues in dependencies |
| Policy Enforcement | Apply security gates and policies |
| CI/CD Integration | Seamless integration with popular CI/CD platforms |
| Multiple Formats | Output in SPDX, CycloneDX, JSON, and more |
| Offline Mode | Generate SBOMs without network connectivity |
Documentation
Installation
Install and set up the CLI
Usage Guide
Common commands and workflows
Configuration
Configure CLI settings
Troubleshooting
Resolve common issues
Support Matrix
Supported languages and platforms
System Requirements
| Requirement | Minimum |
|---|---|
| Node.js | v18.0.0 or higher |
| npm | v8.0.0 or higher |
| Operating System | Windows 10+, macOS 10.15+, Linux (Ubuntu 20.04+) |
| Memory | 4GB RAM recommended |
| Disk Space | 500MB for installation |
Getting Help
# View all commands
safeguard --help
# Get help for a specific command
safeguard sbom --help
safeguard scan --help
safeguard gate --help