README.md

# Vibe ๐ŸŽต

A fun, playful, but practical toolset that helps LLM agents interact with Elixir codebases through custom mix tasks.

## Features

- ๐Ÿง  **IEx Execution**: Run Elixir code in IEx and get formatted results (`mix vibe.iex`)
- ๐Ÿ“š **Documentation**: Access module and function docs in AI-friendly formats (`mix vibe.docs`)
- ๐Ÿ” **Code Analysis**: Analyze code structure and dependencies (`mix vibe.analyze`)
- โœจ **Code Generation**: Generate code snippets and templates (`mix vibe.generate`)
- ๐Ÿงช **Test Running**: Run tests with AI-friendly output (`mix vibe.test`)

## Installation

The package can be installed by adding `vibe` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:vibe, "~> 0.1.0"}
  ]
end
```

## Usage

Start with the help command to see available options:

```shell
mix vibe
```

Run code in IEx and get the result:

```shell
mix vibe.iex "Enum.map(1..5, &(&1 * 2))"
```

Get documentation for a module:

```shell
mix vibe.docs Enum
```

## Configuration

You can configure Vibe in your `config/config.exs`:

```elixir
config :vibe,
  output_format: :markdown,  # or :text, :json
  show_timing: true,
  verbose: false
```

## Documentation

Full documentation is available at [https://hexdocs.pm/vibe](https://hexdocs.pm/vibe).

## License

Vibe is released under the MIT License.