From 15008542a34a9a20372333b7bf676adc168876cd Mon Sep 17 00:00:00 2001 From: Dominik Jain Date: Fri, 19 Dec 2025 00:06:56 +0100 Subject: [PATCH] Move tip to proper place, fix typos, add pointer to '--help' early on --- docs/02-usage/020_running.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/02-usage/020_running.md b/docs/02-usage/020_running.md index a31362f6..10dce262 100644 --- a/docs/02-usage/020_running.md +++ b/docs/02-usage/020_running.md @@ -2,20 +2,20 @@ Serena is a command-line tool with a variety of sub-commands. This section describes - * varies ways of running Serena + * various ways of running Serena * how to run and configure the most important command, i.e. starting the MCP server * other useful commands. -:::{tip} -By default, Serena will use language servers for code understanding and analysis. -With the [Serena JetBrains Plugin](025_jetbrains_plugin), we recently introduced a powerful alternative, -which has several advantages over the language server-based approach. -::: - ## Ways of Running Serena In the following, we will refer to the command used to run Serena as ``, -which you should replace with the appropriate command based on your chosen method. +which you should replace with the appropriate command based on your chosen method, +as detailed below. + +In general, to get help, append `--help` to the command, i.e. + + --help + --help ### Using uvx @@ -98,6 +98,12 @@ Given your preferred method of running Serena, you can start the MCP server usin Note that no matter how you run the MCP server, Serena will, by default, start a web-based dashboard on localhost that will allow you to inspect the server's operations, logs, and configuration. +:::{tip} +By default, Serena will use language servers for code understanding and analysis. +With the [Serena JetBrains Plugin](025_jetbrains_plugin), we recently introduced a powerful alternative, +which has several advantages over the language server-based approach. +::: + ### Standard I/O Mode The typical usage involves the client (e.g. Claude Code, Codex or Cursor) running