[#24225] New VulcanAI terminal documentation by Danipiza · Pull Request #279 · eProsima/vulcanexus

Danipiza · 2026-03-09T09:44:14Z

No description provided.

Signed-off-by: danipiza <dpizarrogallego@gmail.com>

cferreiragonz · 2026-04-28T12:24:27Z

+    console = VulcanConsole(
+        tools_from_entrypoints="turtle_tools",
+        user_context=user_context,
+        main_node=node,
+        model="gpt-5-nano"  # model="ollama-llama3.1:8b" for Ollama models
+    )


We need to update every block of code that refers to lines higher than 80 of this file (docs/resources/tutorials/vulcanai/turtlesim/ros2_node.py).

Example:
File docs/rst/tutorials/vulcanai/turtlesim/turtlesim_main.rst on lines 55, 69.

Render the documentation locally and check that code is properly shown.

Done in c10de33

cferreiragonz · 2026-04-28T12:27:27Z

I actually realized that this image does not fit here. We are using the turtlesim tools, not the default tools. We should see the tools created specifically for this tutorial, with the default tools deactivated. Same as the original image

Done in c10de33

cferreiragonz · 2026-04-28T12:28:00Z

Same here, available tools should be the turtlesim tools, not the default ones.

Done in c10de33

cferreiragonz · 2026-04-28T12:29:31Z

+Image Placeholders
+------------------
+
+Use the following placeholders to add screenshots later.
+
+.. container::
+
+   **image_1** Terminal main view
+
+.. container::
+
+   **image_2** Text selection and copy with ``F4``
+
+.. container::

+   **image_3** Reverse search with ``Ctrl+R``


Delete or add the images

cferreiragonz · 2026-04-28T12:31:32Z

+Even though VulcanAI can be integrated directly in Python applications, the **VulcanAI Console** is the main interactive interface for most users.
+Using the console is not mandatory, but it improves readability and day-to-day usage by presenting prompts, plans, tool calls, and responses in a clearer way during execution.
+For development, debugging and demos, it is usually the most convenient way to run a VulcanAI agent.
+
+The simplest way to run VulcanAI with the console from your own script is to create a ``VulcanConsole`` object and call ``run_console()``:
+
+.. code-block:: python
+
+    from vulcanai import VulcanConsole
+
+    console = VulcanConsole(
+        tools_from_entrypoints="my_tools",
+        user_context="You are assisting with a ROS 2 system.",
+        model="gpt-5-nano"
+    )
+
+    console.run_console()
+
+For ROS 2 use cases, the console can also receive a shared node through the ``main_node`` argument, as shown in :ref:`tutorials_vulcanai_turtlesim_main`.
+See :ref:`vulcanai_terminal` for a detailed overview of the console features and shortcuts.


This is unrelated with VulcanAI tools. It seems missplaced

Totally right, it was my first approach for this comment and it was in a different file and did not remove it

#279 (comment)

Removed in c10de33

cferreiragonz · 2026-04-28T12:31:39Z


  In case of using a *"setup.py"* file of a ROS 2 package, remember to add a new complete module, not another entry to the *"console_scripts"* entry point.

+


Suggested change

Done in c10de33

cferreiragonz · 2026-04-28T12:33:27Z

+
+You can check the console logs to see the plan created by the agent to accomplish each task, as well as the tool calls made during the execution.
+
+.. _vulcanai_tools_sharing_data:


This should go above section: Sharing data between tools

Done in c10de33

cferreiragonz · 2026-04-28T12:44:03Z

+These tools allow VulcanAI agents to inspect and interact with a running ROS 2 system without any additional setup.
+They are automatically available once VulcanAI is installed and are organized by resource type, but each CLI command is exposed as an independent tool inside its category.
+For example, ``ros2 node info`` and ``ros2 node list`` are now two different tools instead of a single ``ros2 node`` tool.
+During terminal execution, tools can be enabled or disabled individually, and complete tool groups can also be enabled or disabled at once.


Suggested change

These tools allow VulcanAI agents to inspect and interact with a running ROS 2 system without any additional setup.

They are automatically available once VulcanAI is installed and are organized by resource type, but each CLI command is exposed as an independent tool inside its category.

For example, ``ros2 node info`` and ``ros2 node list`` are now two different tools instead of a single ``ros2 node`` tool.

During terminal execution, tools can be enabled or disabled individually, and complete tool groups can also be enabled or disabled at once.

These tools give VulcanAI agents built-in access to inspect and interact with a running ROS 2 system, with no additional setup required.

Once VulcanAI is installed, each supported ROS 2 command is available as its own independent tool.

For example, ``ros2 node list`` and ``ros2 node info`` are exposed as separate tools rather than as a single generic ros2 topic tool.

To make tool management easier, related tools are grouped by the first part of the ROS 2 command.

For example, all tools based on ``ros2 node <command>``, such as ``ros2 node list`` and ``ros2 node info``, are included in the ``ros2 node`` tool group.

During terminal execution, users can enable or disable tools one by one, or enable and disable an entire group at once.

Done in c10de33

Signed-off-by: danipiza <dpizarrogallego@gmail.com>

[#24225] Updated documentation with new textual terminal

726504c

Signed-off-by: danipiza <dpizarrogallego@gmail.com>

Danipiza force-pushed the new-vulcanai_terminal branch from 014797e to 726504c Compare March 9, 2026 10:20

cferreiragonz requested changes Mar 17, 2026

View reviewed changes

Danipiza added 2 commits April 28, 2026 11:01

[#24225] Applied revision

45ca6ce

Signed-off-by: danipiza <dpizarrogallego@gmail.com>

[#24225] Applied revision, images

16e448c

Signed-off-by: danipiza <dpizarrogallego@gmail.com>

Danipiza requested a review from cferreiragonz April 28, 2026 10:01

[#24225] Fixed spell check

e77f68c

Signed-off-by: danipiza <dpizarrogallego@gmail.com>

cferreiragonz requested changes Apr 28, 2026

View reviewed changes

[#24225] Applied revision

c10de33

Signed-off-by: danipiza <dpizarrogallego@gmail.com>


		In case of using a "setup.py" file of a ROS 2 package, remember to add a new complete module, not another entry to the "console_scripts" entry point.


		You can check the console logs to see the plan created by the agent to accomplish each task, as well as the tool calls made during the execution.

		.. _vulcanai_tools_sharing_data:

-These tools allow VulcanAI agents to inspect and interact with a running ROS 2 system without any additional setup.
-They are automatically available once VulcanAI is installed and are organized by resource type, but each CLI command is exposed as an independent tool inside its category.
-For example, ``ros2 node info`` and ``ros2 node list`` are now two different tools instead of a single ``ros2 node`` tool.
-During terminal execution, tools can be enabled or disabled individually, and complete tool groups can also be enabled or disabled at once.
+These tools give VulcanAI agents built-in access to inspect and interact with a running ROS 2 system, with no additional setup required.
+Once VulcanAI is installed, each supported ROS 2 command is available as its own independent tool.
+For example, ``ros2 node list`` and ``ros2 node info`` are exposed as separate tools rather than as a single generic ros2 topic tool.
+To make tool management easier, related tools are grouped by the first part of the ROS 2 command.
+For example, all tools based on ``ros2 node <command>``, such as ``ros2 node list`` and ``ros2 node info``, are included in the ``ros2 node`` tool group.
+During terminal execution, users can enable or disable tools one by one, or enable and disable an entire group at once.

Conversation

Danipiza commented Mar 9, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants