Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,23 +157,23 @@ All commands run via `ciberwebscan <command>` or `python -m ciberwebscan`:

| Command | Subcommands | Description |
| ------------ | ------------------------------------------------------- | ---------------------------------------------------------- |
| `analyze` | `url`, `ssl`, `fingerprint`, `cves` | Security analysis (headers, SSL, fingerprints, CVE lookup) |
| `attack` | `test`, `xss`, `sqli` | Attack surface testing |
| `analyze` | (none) | Security analysis (headers, SSL, fingerprints, CVE lookup) |
| `attack` | (none) | Attack surface testing |
| `scrape` | `url`, `batch` | Web scraping (static or dynamic) |
| `quick` | `scan` | Fast combined scan |
| `quick` | (none) | Fast combined scan |
| `config` | `show`, `get`, `set`, `reset`, `keys`, `export`, `load` | Configuration management |
| `api` | `run` | Start REST API server |
| `api` | (none) | Start REST API server |
| `completion` | `install`, `show`, `uninstall` | Shell completion management |
| `version` | (none) | Show version info |

```bash
# Examples
ciberwebscan analyze url https://example.com
ciberwebscan attack xss https://example.com/search
ciberwebscan analyze https://example.com --ssl --fingerprint --cve
ciberwebscan attack https://example.com --consent --xss
ciberwebscan scrape url https://example.com --dynamic
ciberwebscan quick scan https://example.com
ciberwebscan quick https://example.com
ciberwebscan config set logging.level DEBUG
ciberwebscan api run --host 0.0.0.0 --port 8000
ciberwebscan api --host 0.0.0.0 --port 8000
ciberwebscan completion install --shell zsh
```

Expand Down Expand Up @@ -308,7 +308,7 @@ playwright install # Required for dynamic scraping
ciberwebscan # CLI entry point
python -m ciberwebscan # Alternative CLI entry
python -m ciberwebscan.api.app # Direct API server start
ciberwebscan api run # API via CLI
ciberwebscan api # API via CLI

# Testing
pytest # All tests with coverage
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ ENV PYTHONDONTWRITEBYTECODE=1
EXPOSE 8000

ENTRYPOINT ["ciberwebscan"]
CMD ["api", "run", "--host", "0.0.0.0", "--port", "8000"]
CMD ["api", "--host", "0.0.0.0", "--port", "8000"]
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,13 +143,13 @@ ciberwebscan attack --url https://testsite.example.com --enumeration

```bash
# Basic analysis
ciberwebscan quick scan https://example.com
ciberwebscan quick https://example.com

# Analysis + scraping
ciberwebscan quick scan https://example.com -s ".content"
ciberwebscan quick https://example.com -s ".content"

# Full scan with attacks (requires consent)
ciberwebscan quick scan https://example.com --preset high --consent
ciberwebscan quick https://example.com --preset high --consent
```

### REST API Integration
Expand All @@ -159,7 +159,7 @@ ciberwebscan quick scan https://example.com --preset high --consent
To start the server:

```bash
ciberwebscan api run
ciberwebscan api
```

### Interactive Documentation
Expand Down
2 changes: 1 addition & 1 deletion docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Complete REST API reference for CiberWebScan (Beta).
### Starting the API

```bash
ciberwebscan api run
ciberwebscan api
# Server runs on http://localhost:8000
# API docs: http://localhost:8000/docs
# ReDoc docs: http://localhost:8000/redoc
Expand Down
Loading
Loading