andre/crewAI
1
0
Fork 0
mirror of https://github.com/crewAIInc/crewAI.git synced 2026-01-10 00:28:31 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: fix neatlogs documentation (#3171)
Some checks failed
Notify Downstream / notify-downstream (push) Has been cancelled
Details
Mark stale issues and pull requests / stale (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Lucas Gomide
2025-07-16 22:18:04 -03:00
committed by GitHub
parent 2490e8cd46
commit bf248d5118
1 changed files with 8 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/en/observability/neatlogs.mdx
View File

@@ -10,8 +10,6 @@ Neatlogs helps you **see what your agent did**, **why**, and **share it**.
It captures every step: thoughts, tool calls, responses, evaluations. No raw logs. Just clear, structured traces. Great for debugging and collaboration. It captures every step: thoughts, tool calls, responses, evaluations. No raw logs. Just clear, structured traces. Great for debugging and collaboration.
---
## Why use Neatlogs? ## Why use Neatlogs?
CrewAI agents use multiple tools and reasoning steps. When something goes wrong, you need context — not just errors. CrewAI agents use multiple tools and reasoning steps. When something goes wrong, you need context — not just errors.
@@ -37,8 +35,6 @@ The best UX to view a CrewAI trace. Post comments anywhere you want. Use AI to d
![Ai Chat Bot With A Trace](/images/neatlogs-4.png) ![Ai Chat Bot With A Trace](/images/neatlogs-4.png)
![Comments Drawer](/images/neatlogs-5.png) ![Comments Drawer](/images/neatlogs-5.png)
---
## Core Features ## Core Features
- **Trace Viewer**: Track thoughts, tools, and decisions in sequence - **Trace Viewer**: Track thoughts, tools, and decisions in sequence
@@ -49,8 +45,6 @@ The best UX to view a CrewAI trace. Post comments anywhere you want. Use AI to d
- **Ask the Trace (AI)**: Chat with your trace using Neatlogs AI bot - **Ask the Trace (AI)**: Chat with your trace using Neatlogs AI bot
- **Public Sharing**: Publish trace links to your community - **Public Sharing**: Publish trace links to your community
---
## Quick Setup with CrewAI ## Quick Setup with CrewAI
<Steps> <Steps>
@@ -61,7 +55,7 @@ The best UX to view a CrewAI trace. Post comments anywhere you want. Use AI to d
```bash ```bash
pip install neatlogs pip install neatlogs
``` ```
(Latest version 0.8.0, Python 3.8+; MIT license) :contentReference[oaicite:1]{index=1} (Latest version 0.8.0, Python 3.8+; MIT license)
</Step> </Step>
<Step title="Initialize Neatlogs"> <Step title="Initialize Neatlogs">
Before starting Crew agents, add: Before starting Crew agents, add:
@@ -76,18 +70,18 @@ The best UX to view a CrewAI trace. Post comments anywhere you want. Use AI to d
</Step> </Step>
</Steps> </Steps>
---
## Under the Hood ## Under the Hood
According to GitHub, Neatlogs: According to GitHub, Neatlogs:
- Captures thoughts, tool calls, responses, errors, and token stats :contentReference[oaicite:2]{index=2} - Captures thoughts, tool calls, responses, errors, and token stats
- Supports AI-powered task generation and robust evaluation workflows :contentReference[oaicite:3]{index=3} - Supports AI-powered task generation and robust evaluation workflows
All with just two lines of code. All with just two lines of code.
---
## Watch It Work ## Watch It Work
@@ -113,7 +107,7 @@ All with just two lines of code.
allowFullScreen allowFullScreen
></iframe> ></iframe>
---
## Links & Support ## Links & Support
@@ -121,9 +115,9 @@ All with just two lines of code.
- 🔐 [Dashboard & API Key](https://app.neatlogs.com/) - 🔐 [Dashboard & API Key](https://app.neatlogs.com/)
- 🐦 [Follow on Twitter](https://twitter.com/neatlogs) - 🐦 [Follow on Twitter](https://twitter.com/neatlogs)
- 📧 Contact: hello@neatlogs.com - 📧 Contact: hello@neatlogs.com
- 🛠 [GitHub SDK](https://github.com/NeatLogs/neatlogs) :contentReference[oaicite:4]{index=4} - 🛠 [GitHub SDK](https://github.com/NeatLogs/neatlogs)
---
## TL;DR ## TL;DR