Fix heading levels in docs

This commit is contained in:
Dominik Jain authored and Dominik Jain committed 2025-11-08 12:43:17 +01:00
1 parent e436fb3f59
commit 90e123726c
14 files changed
+57 -57

No files matched your search

+11 -11
View File
@@ -1,4 +1,4 @@
## Running Serena
# Running Serena
Serena is a command-line tool with a variety of sub-commands.
This section describes
@@ -6,12 +6,12 @@ This section describes
* how to run and configure the most important command, i.e. starting the MCP server
* other useful commands.
### Ways of Running Serena
## Ways of Running Serena
In the following, we will refer to the command used to run Serena as `<serena>`,
which you should replace with the appropriate command based on your chosen method.
#### Using uvx
### Using uvx
`uvx` is part of `uv`. It can be used to run the latest version of Serena directly from the repository, without an explicit local installation.
@@ -19,7 +19,7 @@ which you should replace with the appropriate command based on your chosen metho
Explore the CLI to see some of the customization options that serena provides (more info on them below).
#### Local Installation
### Local Installation
1. Clone the repository and change into it.
@@ -42,7 +42,7 @@ Explore the CLI to see some of the customization options that serena provides (m
```
(docker)=
#### Using Docker (Experimental)
### Using Docker (Experimental)
⚠️ Docker support is currently experimental with several limitations. Please read the [Docker documentation](https://github.com/oraios/serena/blob/main/DOCKER.md) for important caveats before using it.
@@ -63,7 +63,7 @@ Alternatively, use docker compose with the `compose.yml` file provided in the re
See the [Docker documentation](https://github.com/oraios/serena/blob/main/DOCKER.md) for detailed setup instructions, configuration options, and known limitations.
#### Using Nix
### Using Nix
If you are using Nix and [have enabled the `nix-command` and `flakes` features](https://nixos.wiki/wiki/flakes), you can run Serena using the following command:
@@ -73,7 +73,7 @@ nix run github:oraios/serena -- <command> [options]
You can also install Serena by referencing this repo (`github:oraios/serena`) and using it in your Nix flake. The package is exported as `serena`.
### Running the MCP Server
## Running the MCP Server
Given your preferred method of running Serena, you can start the MCP server using the `start-mcp-server` command:
@@ -82,7 +82,7 @@ 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.
#### Standard I/O Mode
### Standard I/O Mode
The typical usage involves the client (e.g. Claude Code, Codex or Cursor) running
the MCP server as a subprocess and using the process' stdin/stdout streams to communicate with it.
@@ -105,7 +105,7 @@ necessarily has to be started by the client in order for communication to take p
In other words, you do not need to start the server yourself. The client application (e.g. Claude Desktop) takes care of this and
therefore needs to be configured with a launch command.
#### Streamable HTTP Mode
### Streamable HTTP Mode
When using instead the *Streamable HTTP* mode, you control the server lifecycle yourself,
i.e. you start the server and provide the client with the URL to connect to it.
@@ -125,7 +125,7 @@ and then configure your client to connect to `http://localhost:9121/mcp`.
ℹ️ Note that while SSE transport is also supported, its use is discouraged.
(mcp-args)=
#### MCP Server Command-Line Arguments
### MCP Server Command-Line Arguments
The Serena MCP server supports a wide range of additional command-line options.
Use the command
@@ -141,7 +141,7 @@ Some useful options include:
* `--mode <mode>`: specify one or more [modes](modes) to enable (can be passed several times)
* `--enable-web-dashboard <true|false>`: enable or disable the web dashboard (enabled by default)
### Other Commands
## Other Commands
Serena provides several other commands in addition to `start-mcp-server`,
most of which are related to project setup and configuration.