> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aintrust.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> An open-source framework for LLM security testing and red teaming

### Prerequisites

* Python 3.11+

### Installation

<CodeGroup>
  ```bash npm theme={null}
  pip install aixploit
  ```
</CodeGroup>

### Quick Start Guide

<AccordionGroup>
  <Accordion title="1. Environment Setup">
    ```bash theme={null}
    export OPENAI_KEY="sk-xxxxx"
    export OLLAMA_URL="hxxp:"
    export OLLAMA_API_KEY="ollama"
    ```
  </Accordion>

  <Accordion title="2. Basic Implementation">
    ```python theme={null}
    from aixploit.plugins import PromptInjection
    from aixploit.core import run

    target = ["Openai", "", "gpt-3.5-turbo"]
    attackers = [PromptInjection("quick")]

    results = run(attackers, target, os.getenv("OPENAI_KEY"))
    ```
  </Accordion>

  <Accordion title="3. View Results">
    ```python theme={null}
    for idx, attacker in enumerate(attackers):
        print(f"Attacker: {attacker.__class__.__name__}")
        print(f"Success Rate: {success_rates_percentage[idx] * 100:.2f}%")
    ```
  </Accordion>
</AccordionGroup>

## Results Visualization

<Tabs>
  <Tab title="Success Rates">
    The success rates visualization shows the effectiveness of different attack vectors against the target LLM model. Higher percentages indicate more successful prompt injection attempts, helping identify potential vulnerabilities in the model's response patterns.
  </Tab>

  <Tab title="Token Usage">
    Token usage metrics display the computational resources consumed during testing. This visualization helps track and optimize the token consumption across different attack scenarios, providing insights into the efficiency of various testing approaches.
  </Tab>

  <Tab title="Cost Analysis">
    Cost analysis provides a detailed breakdown of expenses associated with different testing strategies. This visualization helps monitor and manage testing costs across various attack vectors, enabling better budget planning and resource allocation for security assessments.
  </Tab>
</Tabs>

## Contributing

<CardGroup cols={3}>
  <Card title="Fork Repository" icon="code-fork">
    Start by forking the repository
  </Card>

  <Card title="Make Changes" icon="code">
    Implement your features or fixes
  </Card>

  <Card title="Submit PR" icon="code-pull-request">
    Create a pull request for review
  </Card>
</CardGroup>

## Support & Community

<CardGroup cols={2}>
  <Card title="Discord Community" icon="discord">
    Join our Discord server for discussions and support
  </Card>

  <Card title="GitHub Issues" icon="github">
    Report bugs and request features on GitHub
  </Card>
</CardGroup>