hackagent.interfaces.cli.commands.examples

Examples Commands

Launch ready-to-run example scenarios from the CLI.

examples

@click.group()
def examples()

🧪 Launch built-in examples from the CLI

list_examples

@examples.command(name="list")
@handle_errors
def list_examples()

📋 List every example campaign.

CAMPAIGN_SCHEMA_URL

Where the docs site serves the campaign JSON Schema.

copy_example

@examples.command(name="copy")
@click.argument("name")
@click.argument("destination", required=False, type=click.Path(path_type=Path))
@click.option("--force",
              is_flag=True,
              help="Overwrite a file that is already there.")
@handle_errors
def copy_example(name: str, destination: Optional[Path], force: bool)

📄 Copy an example campaign here, to edit and run as your own.

DESTINATION is a file or a folder, the current folder by default.

run_example

@examples.command(name="run")
@click.argument("name")
@handle_errors
def run_example(name: str)

▶ Run one example by name, starting its target if it has one.

ollama

@examples.command()
@click.pass_context
@handle_errors
def ollama(ctx)

Run the Ollama h4rm3l demo via CLI (no TUI).

quick_evaluation

@examples.command(name="quick-evaluation")
@handle_errors
def quick_evaluation()

Run the OpenRouter quick evaluation example (h4rm3l).

pc_tool

@examples.command(name="pc-tool")
@handle_errors
def pc_tool()

Run the PC Tool sandbox example: start agent, then launch attack.

db_tool

@examples.command(name="db-tool")
@handle_errors
def db_tool()

Run the DB Tool sandbox example: start agent, then launch attack.

rag_example

@examples.command(name="rag")
@handle_errors
def rag_example()

Run the RAG indirect-injection example.

web_example

@examples.command(name="web")
@handle_errors
def web_example()

Show how to red-team a website chatbot you are authorized to test.