Skip to content

Commit 02f50d9

Browse files
committed
update readme
1 parent 1ef2c63 commit 02f50d9

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@
2323

2424
Launch manual and automated attacks with pre-defined and always up-to-date templates of your favourite tools.
2525

26-
Designed to transparently run locally, remotely or integrated in pipelines, `hckctl` is free and open-source, no vendor lock-in, extensible and built using native providers api.
26+
Designed to transparently run locally, remotely or integrated in pipelines. `hckctl` is free and open-source, no vendor lock-in, extensible and built using native providers api.
2727

2828
Create your vulnerable target (box with a specific CVE or whole infrastructures) or connect to your CTF platform ([HTB](https://www.hackthebox.com), [TryHackMe](https://tryhackme.com), [Vulnlab](https://www.vulnlab.com), etc.) without wasting anymore time on boring installations, environment setup and network configurations.
2929

3030
Leverage the cloud platform or request a dedicated managed cluster to:
31-
* orchestrate complex scenarios
32-
* monitor and observe your security posture
31+
* orchestrate complex attack scenarios
32+
* constantly probe and monitor your security posture
3333
* analyze, aggregate and export results via api
34-
* trigger actions based on events
34+
* trigger instant actions based on observed events and patterns
3535

3636
## Quick start
3737

@@ -93,19 +93,20 @@ hckctl lab ctf-linux
9393
Run a [`task`](https://github.com/hckops/megalopolis/tree/main/task) using pre-defined commands
9494
```bash
9595
# default commands
96-
hckctl task rustscan --command help
97-
hckctl task rustscan --command version
96+
hckctl task gobuster --command help
97+
hckctl task fuzzer/ffuf --command version
9898
9999
# use the "default" preset arguments
100-
hckctl task rustscan --input address=127.0.0.1
100+
hckctl task rustscan
101101
# equivalent of
102-
hckctl task rustscan --command default --input address=127.0.0.1
102+
hckctl task rustscan --input address=127.0.0.1
103+
hckctl task scanner/rustscan --command default --input address=127.0.0.1
103104
104105
# use the "full" preset arguments
105106
hckctl task nmap --command full --input address=127.0.0.1 --input port=80
106107
107108
# invoke it with custom arguments
108-
hckctl task rustscan --inline -- -a 127.0.0.1
109+
hckctl task nuclei --inline -- -u https://example.com
109110
110111
# monitor the logs
111112
tail -F ${HOME}/.local/state/hck/task/log/task-rustscan-*
@@ -231,23 +232,24 @@ tail -F ${HOME}/.local/state/hck/log/hckctl-*.log
231232

232233
> TODO example of how to point to a specific pr/revision in a forked repo
233234

234-
## Disclaimer
235-
236-
> TODO
237-
238235
<!--
239236

237+
* rename `template` to catalog? or alias?
238+
* cmd aliases e.g. start/up/create
239+
* replace task/htb example with thm
240+
240241
TODO
241242
* priority
242243
- add task providers: kube and cloud
243244
- add box kube --network-vpn
244245
- debug `htb-postman`
245-
- play htb: linux/win
246246
- add flow example
247247
- verify kube/cloud distroless support
248248
- verify kube/cloud no-shell support
249+
- play htb: linux/win
249250
- RELEASE
250251
* general
252+
- add disclaimer to readme?
251253
- public discord server (review channels visibility)
252254
- brew release
253255
- review context/http/client timeouts e.g. vpn or target not available

0 commit comments

Comments
 (0)