FAQ

Frameworks & Detection

Which frameworks does AgentLantern support?

Framework	Analysis	Detection
CrewAI	Full	crewai in dependencies, or crew.py with @CrewBase
LangGraph	Full	dependency or StateGraph usage
AutoGen	Full	dependency or AutoGen imports
Smolagents	Full	dependency or Smolagents imports
Google ADK	Full	dependency or Google ADK imports
OpenAI Agents SDK	Full	openai-agents or agents imports
Additional Python ecosystems	Dedicated	PydanticAI, LlamaIndex, Semantic Kernel, Agno, LangChain, Haystack, Strands, CAMEL-AI, MetaGPT, BeeAI, Swarm
JavaScript/TypeScript	Dedicated	Mastra, Vercel AI SDK Agents, Strands, BeeAI
Semantic Kernel .NET/Java	Dedicated	project dependency or agent API
Other Python or JS/TS frameworks	Generic	conventional agent constructors, subclasses or factories

What happens if my framework has no dedicated analyzer?

AgentLantern's generic Python and JavaScript/TypeScript analyzers extract conventional constructors, factories, instructions, tools, relationships and run calls. For unusual APIs, add a plugin analyzer through the agentlantern.analyzers entry point.

How does auto-detection work?

AgentLantern combines normalized dependencies with framework-specific import and API signatures. The generic analyzer is checked last to avoid overriding a dedicated analyzer.

What if no framework is detected?

You will see a NoFrameworkDetected error listing the supported frameworks. Check the dependency declaration and ensure agent constructors are present in source. For an unusual API, install or create a dedicated analyzer plugin.

Can I use AgentLantern with a custom / internal agent framework?

Yes. Conventional Python and JavaScript/TypeScript APIs work through generic fallbacks. For deeper extraction, publish a BaseAnalyzer through the agentlantern.analyzers entry point. See the README for details.

Installation

What Python versions are required?

Python 3.11 or higher.

How do I install AgentLantern?

pip install "agentlantern @ git+https://github.com/brellsanwouo/agentlantern.git"
# or
uv tool install git+https://github.com/brellsanwouo/agentlantern.git

How do I update?

pip install --upgrade "agentlantern @ git+https://github.com/brellsanwouo/agentlantern.git"
# or
uv tool install --force git+https://github.com/brellsanwouo/agentlantern.git

lantern command not found after install

If installed with uv tool, make sure ~/.local/bin is in your PATH. Check with:

uv tool list
which lantern

Which lantern is being used?

which lantern

If it points to an old version (e.g. ~/.local/share/uv/tools/agentlantern/), reinstall:

uv tool install --force git+https://github.com/brellsanwouo/agentlantern.git

Usage

How do I generate documentation?

lantern docs /path/to/your-agent-project
# or from the project root:
lantern docs

How do I view the documentation?

lantern web /path/to/your-agent-project
# Open http://localhost:9000

How do I watch a crew run live?

Use lantern play:

lantern play /path/to/your-agent-project

Open the URL printed in the terminal, then click START in the UI. Use STOP to terminate the active run.

If you did not pass --name, the UI asks for a run name before START and saves the replay with that name.

What does lantern play show?

It shows a pixel-art live playground with dynamic agent placement, agent thought bubbles, a central Tool Hub for tool calls, timeline/thoughts/tools/comms/log panels, and final report.md display when available.

For 1 to 10 agents, the UI uses dedicated layouts with exactly n visible agents. No empty agent placeholders are displayed.

Port 9000 is already in use

lantern web --port 9001

How do I stop the web server?

Press Ctrl+C in the terminal running lantern web.

Can I serve without regenerating?

lantern web --no-generate

Can I run documentation for multiple projects at the same time?

Yes — use a different port for each:

lantern web ~/projects/project-a --port 9000
lantern web ~/projects/project-b --port 9001

Documentation Content

Can I edit the generated files?

Yes, but they will be overwritten the next time you run lantern docs.

How do I share the documentation without running a server?

Send docs/agentlantern-docs.html. It works without a server; Mermaid diagram rendering still requires network access to its CDN.

How do I publish to GitHub Pages?

1. Run lantern docs
2. Commit and push the docs/ folder
3. Enable GitHub Pages in repository settings, source: /docs

Why don't the Mermaid diagrams render?

Mermaid requires a browser environment. Use lantern web (or any web viewer that supports Mermaid) instead of a plain Markdown editor.

Troubleshooting

NoFrameworkDetected error

Check that pyproject.toml lists a supported framework in [project] dependencies.

FileNotFoundError: Could not find crew.py

You are running an old version of lantern. Update with uv tool install --force git+https://github.com/brellsanwouo/agentlantern.git.

Documentation content is empty

For CrewAI: verify that agents.yaml, tasks.yaml, and crew.py exist and are populated, then re-run lantern docs.

lantern play opens, but START does nothing

First confirm the browser is connected to the WebSocket port printed by lantern play. With custom ports:

lantern play --ws-port 8790 --http-port 8791

open:

http://127.0.0.1:8791?ws=8790

If the UI still appears stale, close the tab and reopen the printed URL. If installed with uv tool, refresh the command:

uv tool install --force git+https://github.com/brellsanwouo/agentlantern.git

When developing AgentLantern from a local checkout:

uv tool install --force --refresh .

lantern play starts, but the UI does not update

Check the Log panel and the terminal running lantern play. The target project may be waiting on an API key, model call, dependency install, or external tool. For browser cache issues, close the old tab and reopen the printed URL.

How do I save and replay a run?

lantern play /path/to/project --name demo-run
lantern replay demo-run
lantern replay last

Saved runs are written to .lantern_replays/<name>.jsonl in the target project.

General

Is AgentLantern free?

Yes — MIT license, open source.

Where do I report bugs?

Open an issue on the GitHub repository.

Can I contribute?

Yes — contributions are welcome, especially new framework analyzers.