Skip to content

[Docs] Create QUICKSTART.md - 5 minute getting started guide #34

@marctjones

Description

@marctjones

Summary

Create a quick start guide for new users to get up and running in 5 minutes.

Target Audience

  • Developers wanting to use ebpf-assist with Claude Code
  • Users who want to try it without reading full docs

Suggested Structure

# Quick Start

## Prerequisites
- Linux with kernel 5.x+
- Rust toolchain
- clang, libbpf-dev

## Install (2 min)
git clone ...
./scripts/install.sh

## Configure Claude Code (1 min)
Add to ~/.claude.json: ...

## First eBPF Program (2 min)
# Create
ebpf-assist new kprobe hello --target do_sys_openat2

# Build & Run
ebpf-assist compile hello.c
ebpf-assist load hello.o
ebpf-assist attach 1 do_sys_openat2

# Test
ebpf-assist trigger syscall openat /tmp/test
ebpf-assist output trace

## Next Steps
- Read docs/SKILL.md for AI workflow
- Try MicroVM isolation: ebpf-assist load --isolate

Location

docs/QUICKSTART.md with link from README

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood-first-issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions