Vibe (vibe v0.1.0)

Vibe Coding - Help LLMs interact with your Elixir codebase.

This package provides mix tasks that make it easier for LLM agents to interact with Elixir codebases in a fun, playful, but practical way.

Usage

To enable tracing in a module:

use Vibe, enabled: true

def my_function do
  vibe("This is a tracing log", variable: value)
end

The vibe/1 function will only output logs when enabled is set to true.

Summary

Functions

format_output(data, format \\ nil)

Format output based on the configured output format.

output_format()

Get the configured output format.

show_timing?()

Check if showing timing information is enabled.

verbose?()

Check if verbose mode is enabled.

Functions

format_output(data, format \\ nil)

Format output based on the configured output format.

Examples

iex> Vibe.format_output("Hello world")
"Hello world"

iex> map = %{hello: "world"}
iex> result = Vibe.format_output(map)
iex> String.contains?(result, "hello") and String.contains?(result, "world")
true

output_format()

Get the configured output format.

Examples

iex> Vibe.output_format()
:markdown

show_timing?()

Check if showing timing information is enabled.

Examples

iex> Vibe.show_timing?()
true

verbose?()

Check if verbose mode is enabled.

Examples

iex> Vibe.verbose?()
false