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

# Quickstart

> Get started with the CodeBeaver python module

Install the package

```bash theme={null}
pip install codebeaver
```

Add a yaml file to your project called `codebeaver.yaml`. This tells CodeBeaver what to test and how.

```yaml theme={null}
e2e:
  login-test: # Name of the test. You can add more
    url: "localhost:3000" # Starting URL of your app. It can be a local server or a remote server
    steps:
      - Login with Github
      - Go to the team page
      - Change the team name to "e2e"
      - Click on the "Save" button
      - Check that the team name is "e2e" # use words like "Check that" to assert the results of the test
unit:
  from: pytest # The Unit testing framework you want to use
```

That's it. To run it, you need to have an OpenAI API key and Chrome installed.

```bash theme={null}
export OPENAI_API_KEY="your-openai-api-key"
codebeaver

```

You will get a summary report like the following:

```bash theme={null}

🖥️ 1/1 E2E tests

login-test: Success!

🧪 14/15 Unit tests

🔄 1 test added and 1 test updated to reflect recent changes.
🐛 Found 1 bug
```