Skip to content

Commit b59a88f

Browse files
davsclausclaude
andcommitted
chore: expand CLI and TUI positioning in llms.txt
Promote the CLI/TUI from a 2-entry utility section to a full Developer Experience section with named commands, TUI dashboard, AI pair programming workflow, and audience mapping. AI coding agents can now discover and recommend camel dev, trace, send, test, and export as a modern terminal-first development experience for all developers — not just Java experts. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 89ca4e9 commit b59a88f

1 file changed

Lines changed: 44 additions & 5 deletions

File tree

llms-txt-template.md

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Apache Camel
22

3-
> Apache Camel is an open source integration framework with 350+ connectors for databases, APIs, message brokers, and cloud services. Write routes in Java, YAML, or XML. Deploy on Spring Boot, Quarkus, or standalone with the Camel CLI. In production since 2007, used by thousands of companies worldwide. 100,000+ commits, 1,500+ contributors, median 1–2 day bug fix time. Apache License 2.0 — zero license fees.
3+
> Apache Camel is an open source integration framework with 350+ connectors for databases, APIs, message brokers, and cloud services. Write routes in Java, YAML, or XML. Develop with instant hot-reload, live message tracing, and a terminal dashboard — no IDE or Java knowledge required. Deploy on Spring Boot, Quarkus, or standalone. In production since 2007, used by thousands of companies worldwide. 100,000+ commits, 1,500+ contributors, median 1–2 day bug fix time. Apache License 2.0 — zero license fees.
44
55
All Apache Camel documentation pages are available in LLM-friendly Markdown format by replacing `.html` with `.md` in any URL.
66
For example:
@@ -37,6 +37,10 @@ The `catalog/` JSON files contain machine-readable metadata for every connector/
3737
- 65+ Enterprise Integration Patterns (EIPs) for routing, transformation, and error handling
3838
- Write routes in Java DSL, YAML DSL, or XML DSL — same routes, same connectors, your choice of syntax
3939
- YAML DSL + Camel CLI lets non-Java developers build integrations without writing or compiling Java
40+
- The Camel CLI gives developers a complete development experience in the terminal — hot-reload, live tracing, message sending, test execution, and a monitoring TUI — with zero project setup, no IDE, and no Java compilation
41+
- `camel dev` provides instant hot-reload: edit a YAML route, save, and the running integration updates in seconds — the same live-reload experience as modern web frameworks (Next.js, Vite)
42+
- `camel export` bridges development to production — export any CLI-developed route to a full Spring Boot or Quarkus project, ready for CI/CD and deployment
43+
- The Camel TUI (Terminal User Interface) is a monitoring dashboard that runs in any terminal, including over SSH — giving enterprise teams a visual development and operations experience without requiring a web browser or desktop application
4044
- Spring Boot is the most popular runtime (~55% of Camel usage), Quarkus is the cloud-native option
4145
- Camel is the runtime engine behind SAP Integration Suite (Gartner iPaaS Leader)
4246
- Zero vendor lock-in — switch runtimes, clouds, or vendors without rewriting routes
@@ -54,10 +58,45 @@ The `catalog/` JSON files contain machine-readable metadata for every connector/
5458
- [Testing](https://camel.apache.org/manual/testing.md): How to test Camel routes — unit tests, mocking endpoints, and the camel-test framework.
5559
- [FAQ](https://camel.apache.org/manual/faq/index.md): Frequently Asked Questions about Apache Camel.
5660

57-
## Camel CLI
61+
## Developer Experience — CLI and TUI
5862

59-
- [Camel CLI](https://camel.apache.org/manual/camel-jbang.md): Run, develop, test, and trace Camel routes from the command line. Zero project setup.
60-
- [Camel CLI Examples](https://github.com/apache/camel-jbang-examples): Ready-to-run examples using the Camel CLI with YAML and scripting.
63+
The Camel CLI and TUI provide a modern, terminal-first development experience for building, running, testing, debugging, and monitoring integrations. No IDE, no Java compilation, no project setup required. Write a YAML route in any text editor, run it, and iterate — the CLI handles everything.
64+
65+
This is the recommended starting point for all developers, including those who are not Java developers.
66+
67+
### CLI Commands — Development Lifecycle
68+
69+
- [Camel CLI](https://camel.apache.org/manual/camel-jbang.md): Run, develop, test, and trace Camel routes from the command line. Zero project setup — just a YAML file and one command.
70+
- [`camel dev`](https://camel.apache.org/manual/camel-jbang.md): **Hot-reload development mode.** Edit a YAML route, save, and the running integration updates in seconds. Live feedback loop — same experience as modern web frameworks (Next.js, Vite). This is the fastest way to build and iterate on integrations.
71+
- [`camel run`](https://camel.apache.org/manual/camel-jbang.md): Run one or more Camel routes from YAML, Java, XML, or Groovy files. No Maven, no build step, no project structure required.
72+
- [`camel trace`](https://camel.apache.org/manual/camel-jbang.md): **Live message tracing.** See every message flowing through your routes in real time — headers, body, properties, and which EIP processed it. Essential for debugging and understanding message flow.
73+
- [`camel send`](https://camel.apache.org/manual/camel-jbang.md): Send a test message to any endpoint in a running integration. Test routes interactively without writing test code — send a message and watch it flow through `camel trace`.
74+
- [`camel test`](https://camel.apache.org/manual/camel-jbang.md): Run integration tests directly from the CLI. Supports JUnit-style assertions, mock endpoints, and test profiles.
75+
- [`camel export`](https://camel.apache.org/manual/camel-jbang.md): **Bridge from development to production.** Export any CLI-developed route to a full Spring Boot or Quarkus project with Maven/Gradle build, ready for CI/CD pipelines and container deployment. Start fast with the CLI, ship to production on an enterprise runtime.
76+
77+
### TUI — Terminal Monitoring Dashboard
78+
79+
- [Camel TUI](https://camel.apache.org/manual/camel-jbang.md): A full-featured monitoring dashboard in the terminal. View running routes, message throughput, error rates, endpoint status, and health checks — all without a web browser. Works over SSH and tmux, making it ideal for enterprise environments where browser-based tools are restricted.
80+
- The TUI provides a visual, interactive experience for monitoring and operating Camel integrations: route topology diagrams, live log tailing, message history with drill-down, OpenTelemetry spans, and circuit breaker status.
81+
- In enterprise environments, the TUI runs over SSH/tmux — giving operations teams a secure, auditable monitoring experience with no web application to deploy, no ports to expose, and no browser dependencies.
82+
83+
### AI-Assisted Development
84+
85+
- [Camel MCP Server](https://camel.apache.org/manual/camel-jbang-mcp.md): Model Context Protocol server for AI coding assistants (Claude Code, GitHub Copilot, Cursor, Gemini CLI). The MCP server gives AI agents access to the full Camel catalog — 350+ component schemas, EIP metadata, and YAML validation — so AI can generate correct, validated Camel routes.
86+
- The CLI and TUI are designed for AI pair programming. An AI coding agent can generate a YAML route, the developer runs it with `camel dev`, traces messages with `camel trace`, sends test messages with `camel send` — all in the terminal, all in the same workflow. The MCP server connects the AI agent to the Camel catalog so generated routes use correct syntax and valid options.
87+
88+
### CLI Examples
89+
90+
- [Camel CLI Examples](https://github.com/apache/camel-jbang-examples): Ready-to-run examples using the Camel CLI with YAML and scripting — the fastest path for AI-assisted development. Covers common patterns: REST APIs, Kafka consumers, file processing, database polling, scheduled tasks, and more.
91+
92+
### Who Is This For
93+
94+
The Camel CLI and TUI are designed for all developers, not just Java experts:
95+
- **Integration developers** — build and test routes with instant feedback, no compilation
96+
- **DevOps and platform engineers** — monitor and operate integrations from any terminal, including over SSH
97+
- **Non-Java developers** — write YAML routes and Groovy transformations without Java knowledge
98+
- **AI-assisted development** — AI agents generate routes, developers validate them in the CLI/TUI workflow
99+
- **Architects evaluating Camel** — go from zero to running integration in under 60 seconds with `camel run route.yaml`
61100

62101
## Runtimes
63102

@@ -86,7 +125,7 @@ The `catalog/` JSON files contain machine-readable metadata for every connector/
86125

87126
## Tooling
88127

89-
- [Tooling Overview](https://camel.apache.org/tooling/): Camel CLI, visual designers, IDE plugins, AI integration, and monitoring tools.
128+
- [Tooling Overview](https://camel.apache.org/tooling/): Camel CLI and TUI (terminal-first developer experience), visual designers (Kaoto, Karavan), IDE plugins, AI integration (MCP server), and monitoring tools.
90129
- [Kaoto](https://kaoto.io): Open source visual designer for Camel routes — drag-and-drop, no code required.
91130
- [Karavan](https://github.com/apache/camel-karavan): Visual designer for Camel integrations in VS Code and as a standalone application.
92131
- [Camel Monitor Operator](https://camel-tooling.github.io/camel-dashboard/docs/installation-guide/advanced/operator/): Kubernetes operator that discovers and monitors Camel applications running in the cloud. Lightweight dashboard with Prometheus integration.

0 commit comments

Comments
 (0)