Skip to content

Commit 68b31f1

Browse files
authored
Update README.md
1 parent a52a0cc commit 68b31f1

File tree

1 file changed

+13
-26
lines changed

1 file changed

+13
-26
lines changed

README.md

Lines changed: 13 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -101,23 +101,19 @@ zeropath scan --repository-url https://git.example.com/repo --vcs generic
101101
```
102102

103103
#### CI/CD Integration
104-
For continuous integration pipelines, use the `--ci` flag to run PR/merge request scans:
104+
All repository scans exit with code 1 when vulnerabilities are found, making them CI-ready out of the box:
105105
```bash
106-
# Basic CI scan
107-
zeropath scan --repository-id <repositoryId> --ci
108-
109-
# CI scan with explicit PR branches
110-
zeropath scan --repository-id <repositoryId> --ci \
111-
--pr-branch feature/new-feature \
112-
--pr-target main
113-
114-
# CI scan by repository URL
115-
zeropath scan --repository-url https://github.com/owner/repo --vcs github --ci \
116-
--pr-branch feature/new-feature \
117-
--pr-target main
106+
# Scan a repository (exits 1 if issues found)
107+
zeropath scan --repository-id <repositoryId>
108+
109+
# Scan a specific branch
110+
zeropath scan --repository-id <repositoryId> --branch main
111+
112+
# Scan by repository URL
113+
zeropath scan --repository-url https://github.com/owner/repo --vcs github
118114
```
119115

120-
**CI Mode Exit Codes:**
116+
**Exit Codes:**
121117
- **0**: No vulnerabilities found
122118
- **1**: Vulnerabilities detected (fails CI pipeline)
123119

@@ -130,10 +126,7 @@ zeropath scan --repository-url https://github.com/owner/repo --vcs github --ci \
130126
| `--repository-id <id>` | Scan an existing repository by ID |
131127
| `--repository-url <url>` | Scan a repository by URL (requires `--vcs`) |
132128
| `--vcs <provider>` | VCS provider: `github`, `gitlab`, `bitbucket`, or `generic` |
133-
| `--branch <name>` | Branch to scan (for regular scans) |
134-
| `--ci` | Run a CI/PR scan instead of a full scan |
135-
| `--pr-branch <name>` | Source/feature branch for CI scans |
136-
| `--pr-target <name>` | Target/base branch for CI scans |
129+
| `--branch <name>` | Branch to scan |
137130

138131
### Examples
139132

@@ -144,11 +137,6 @@ zeropath scan ./my-project report.sarif
144137
# Scan main branch of a repository
145138
zeropath scan --repository-id abc-123-def --branch main
146139

147-
# CI pipeline scanning a pull request
148-
zeropath scan --repository-id abc-123-def --ci I am running a few minutes late; my previous meeting is running over.
149-
--pr-branch feature/security-fix \
150-
--pr-target main
151-
152140
# Scan a GitHub repository directly
153141
zeropath scan --repository-url https://github.com/myorg/myapp --vcs github
154142

@@ -161,9 +149,9 @@ zeropath scan --repository-url https://gitlab.com/myorg/myapp --vcs gitlab --bra
161149
- **Real-time scanning**: All scans wait for completion and show progress
162150
- **CI/CD ready**: Exit codes for pipeline integration (1 for vulnerabilities, 0 for clean)
163151
- **Multiple VCS support**: GitHub, GitLab, Bitbucket, and generic Git repositories
164-
- **Branch-aware**: Scan specific branches or PR/merge requests
152+
- **Branch-aware**: Scan specific branches
165153
- **SARIF output**: Industry-standard format for local scans
166-
- **Vulnerability reporting**: Detailed breakdown by severity in CI mode
154+
- **Vulnerability reporting**: Detailed breakdown by severity
167155

168156
### Help
169157
```bash
@@ -173,7 +161,6 @@ zeropath scan --help
173161

174162
## Support
175163
- Email: support@zeropath.com
176-
- [Discord Community](https://discord.gg/ZRqDvZ6qjJ)
177164
- [Issue Tracker](https://github.com/ZeroPathAI/zeropath-cli/issues)
178165

179166
## License

0 commit comments

Comments
 (0)