From f9580315552395383b7d32fc91bfc2deb9f01bee Mon Sep 17 00:00:00 2001 From: Dominik Jain Date: Fri, 7 Nov 2025 20:50:09 +0100 Subject: [PATCH] Add/improve docs on dashboard/GUI tool --- docs/02-usage/060_dashboard.md | 22 ++++++++++++++++++++++ docs/02-usage/999_detailed-usage.md | 22 ---------------------- 2 files changed, 22 insertions(+), 22 deletions(-) create mode 100644 docs/02-usage/060_dashboard.md diff --git a/docs/02-usage/060_dashboard.md b/docs/02-usage/060_dashboard.md new file mode 100644 index 00000000..c8babaac --- /dev/null +++ b/docs/02-usage/060_dashboard.md @@ -0,0 +1,22 @@ +## The Dashboard and GUI Tool + +Serena comes with built-in tools for monitoring and managing the current session: + +* the **web-based dashboard** (enabled by default) + + The dashboard provides detailed information on your Serena session, the current configuration and provides access to logs. + Some settings (e.g. the current set of active programming languages) can also be directly modified through the dashboard. + + The dashboard is supported on all platforms. + + By default, it will be accessible at `http://localhost:24282/dashboard/index.html`, + but a higher port may be used if the default port is unavailable/multiple instances are running. + +* the **GUI tool** (disabled by default) + + The GUI tool is a native application window which displays logs. + + This is mainly supported on Windows, but it may also work on Linux; macOS is unsupported. + +Both can be enabled, configured or disabled in Serena's [configuration](050_configuration) file (`serena_config.yml`). +If enabled, they will automatically be opened as soon as the Serena agent/MCP server is started. diff --git a/docs/02-usage/999_detailed-usage.md b/docs/02-usage/999_detailed-usage.md index 63b05e07..9cdeaaee 100644 --- a/docs/02-usage/999_detailed-usage.md +++ b/docs/02-usage/999_detailed-usage.md @@ -72,28 +72,6 @@ Moreover, Serena is instructed to be frugal with context but we found that Claude is not always very good in being frugal (Gemini seemed better at it). You can explicitly instruct it to not read the bodies if you know that it's not needed. -### Serena's Logs: The Dashboard and GUI Tool - -Serena provides two convenient ways of accessing the logs of the current session: - -* via the **web-based dashboard** (enabled by default) - - This is supported on all platforms. - By default, it will be accessible at `http://localhost:24282/dashboard/index.html`, - but a higher port may be used if the default port is unavailable/multiple instances are running. - -* via the **GUI tool** (disabled by default) - - This is mainly supported on Windows, but it may also work on Linux; macOS is unsupported. - -Both can be enabled, configured or disabled in Serena's configuration file (`serena_config.yml`, see above). -If enabled, they will automatically be opened as soon as the Serena agent/MCP server is started. -The web dashboard will display usage statistics of Serena's tools if you set `record_tool_usage_stats: True` in your config. - -In addition to viewing logs, both tools allow to shut down the Serena agent. -This function is provided, because clients like Claude Desktop may fail to terminate the MCP server subprocess -when they themselves are closed. - ### Serena and GIT worktrees [git-worktree](https://git-scm.com/docs/git-worktree) can be an excellent way to parallelize your work. More on this in [Anthropic: Run parallel Claude Code sessions with Git worktrees](https://docs.claude.com/en/docs/claude-code/common-workflows#run-parallel-claude-code-sessions-with-git-worktrees).