diff --git a/README.md b/README.md index a3dc68a..d5e899e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ # GPTtrace 🤖 +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + + Generate eBPF programs and tracing with ChatGPT and natural language ## Key Features 💡 ### Interact and Tracing your Linux with natural language, it can tell how to write eBPF programs in `BCC`, `libbpf` styles. -![result](doc/result.png) +example: tracing with Count page faults by process + +![result](doc/result.gif) ### Generate eBPF programs with natural language @@ -43,12 +48,18 @@ optional arguments: ### Use prompts to teach ChatGPT to write eBPF programs -TODO +```sh +./GPTtrace.py -t +``` + +This will use the material in the `prompts` directory to teach ChatGPT to write eBPF programs in bpftrace, libbpf, and BCC styles. You can also do that manually by sending the prompts to ChatGPT in the Website. ### start your tracing! 🚀 +For example: + ```sh -./GPTtrace -e "Count page faults by process" +./GPTtrace.py -e "Count page faults by process" ``` ## Installation 🔧 diff --git a/doc/result.gif b/doc/result.gif new file mode 100644 index 0000000..52d2bf7 Binary files /dev/null and b/doc/result.gif differ