# Gonzo Docs

Gonzo is a Go-based TUI (Terminal User Interface) log analysis tool that helps you analyze log streams with beautiful charts, AI-powered insights, and advanced filtering - all from your terminal.

<figure><img src="https://3483934249-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SdDsOcMkqsJoxnydVXB%2Fuploads%2FBPcyheXEPrUiSIXy6oIC%2Fgonzo-mascot-smaller.png?alt=media&#x26;token=b57a5311-b132-4b10-af0c-143772f9bb35" alt="" width="375"><figcaption></figcaption></figure>

> Gonzo: a powerful, real-time log analysis terminal UI inspired by [k9s](https://k9scli.io/).

<figure><img src="https://3483934249-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SdDsOcMkqsJoxnydVXB%2Fuploads%2Fu2cj3geRfoGFjclton1I%2Fgonzo-main.png?alt=media&#x26;token=e72afa70-3461-4334-9351-520ba656fb49" alt=""><figcaption></figcaption></figure>

### ✨ Key Features

* **Live Streaming** - Process logs as they arrive from stdin, files, or network
* **OTLP Native** - First-class support for OpenTelemetry (OTLP) log format
* **Format Detection** - Automatically detects JSON, logfmt, and plain text
* **k9s-Inspired Layout** - Familiar 2x2 grid interface
* **Real-time Charts** - Word frequency, attributes, severity distribution, and time series
* **AI Analysis** - Get intelligent insights about log patterns and anomalies
* **Smart Navigation** - Keyboard + mouse controls with vim-style shortcuts

### 🚀 Quick Start

Install Gonzo using your preferred method:

{% tabs %}
{% tab title="Go Install" %}

```bash
go install github.com/control-theory/gonzo/cmd/gonzo@latest
```

{% endtab %}

{% tab title="Homebrew" %}

```bash
brew install gonzo
```

{% endtab %}

{% tab title="Binary Download" %}
Download the latest release for your platform from the [releases page](https://github.com/control-theory/gonzo/releases).
{% endtab %}
{% endtabs %}

Start analyzing logs immediately:

```bash
# Analyze a log file
gonzo -f application.log

# Follow logs in real-time
gonzo -f /var/log/app.log --follow

# Analyze logs from stdin (traditional way)
cat application.log | gonzo

# Pipe from other commands
kubectl logs -f deployment/my-app | gonzo

# Grab Kubernetes logs natively (using kubeconfig)
gonzo --k8s-enabled=true
```

### 📖 Documentation Sections

{% hint style="info" %}
**New to Gonzo?** Start with the [Getting Started](https://docs.controltheory.com/controltheory-documentation/gonzo-docs/getting-started) section for installation and basic usage.
{% endhint %}

#### Essential Reading

* **Installation** - Get Gonzo up and running
* **Quick Start** - Your first log analysis
* **Interface Overview** - Understanding the dashboard

#### Core Features

* **Log Input Methods** - Files, stdin, and OTLP
* **Patterns** - Bubble up patterns and severity across your logs
* **Filtering & Search** - Find what matters
* **AI Integration** - (Optional) Intelligent log insights

#### Advanced Usage

* **Configuration** - Customize your experience
* **Integration Examples** - Real-world scenarios
* **Troubleshooting** - Common issues and solutions

### 🔗 Links

* **GitHub Repository:** [control-theory/gonzo](https://github.com/control-theory/gonzo)
* **Report Issues:** [GitHub Issues](https://github.com/control-theory/gonzo/issues)
* **Discussions:** [GitHub Discussions](https://github.com/control-theory/gonzo/discussions)

### 🤝 Community

Gonzo is an open-source project built by the community. We welcome contributions, feedback, and bug reports!

* Star the project on [GitHub](https://github.com/control-theory/gonzo) if you find it useful
* Join the conversation in [GitHub Discussions](https://github.com/control-theory/gonzo/discussions)
* Join our [Slack channel](https://join.slack.com/t/ctrltheorycommunity/shared_invite/zt-3dr6rke5w-GlcRaW2bvn4zcSaV8byZgA)
* Check out our [Contributing Guidelines](https://github.com/control-theory/gonzo/blob/main/CONTRIBUTING.md)

***

*Made with ❤️ by* [*ControlTheory*](https://www.controltheory.com/) *and the Gonzo community*


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.controltheory.com/controltheory-documentation/gonzo-docs.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
