mirror of
https://github.com/tiennm99/serena.git
synced 2026-10-13 00:15:05 +00:00
Docs: minor changes
This commit is contained in:
1 parent
d3588b3898
commit
ef8f0ac404
2 files changed
+19
-16
No files matched your search
@@ -180,14 +180,18 @@ Explore the full set of commands and options using the CLI itself!
|
||||
|
||||
Depending on your requirements, you may want to run Serena in different ways.
|
||||
When applying one of these approaches, replace `serena` in commands mentioned throughout the documentation
|
||||
with the respective command and options.
|
||||
with the respective command and options. The same applies to `serena-hooks` commands.
|
||||
|
||||
### Using uvx to Run the Latest Source Version
|
||||
|
||||
|
||||
`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.
|
||||
|
||||
uvx -p 3.13 --from git+https://github.com/oraios/serena serena
|
||||
|
||||
This was previously the main way of running Serena.
|
||||
Since this has the downside that every new commit in the repository will trigger a (potentially slow) re-synchronization, an [installation](010_installation) of Serena should usually be preferred.
|
||||
If you should experience timeouts when connecting the MCP server, consider switching.
|
||||
If, however, the synchronisation is fast enough for you, this is still a good option.
|
||||
|
||||
### Running from Cloned Source
|
||||
|
||||
|
||||
@@ -134,14 +134,13 @@ set ENABLE_TOOL_SEARCH=true && claude
|
||||
in Windows CMD to launch Claude Code.
|
||||
|
||||
**Hooks.**
|
||||
Claude Code's agent can sometimes drift away from using MCP tools during long sessions, falling back
|
||||
to built-in tools or forgetting to load Serena's instructions. Serena provides hook commands that
|
||||
automatically remind the agent to use Serena's tools when appropriate.
|
||||
Due to recent changes (especially dynamic tool loading) in Claude Code, the agent will often fail to make proper use
|
||||
of Serena's tools, either by failing to load them in the beginning or by forgetting the instructions in a long session
|
||||
(a behavior known as agent drift). To counteract this, we provide reminder hooks. We **strongly recommend** setting
|
||||
up the hooks as below (or a variation thereof) for optimal performance of Serena in Claude Code.
|
||||
|
||||
:::{note}
|
||||
Hooks are an **alpha feature** that we provide to overcome context drift in several agent harnesses
|
||||
(where agents, especially those powered by Anthropic models, may forget to load and use MCP tools or
|
||||
fail to read MCP instructions).
|
||||
While recommended, hooks are an **alpha feature**. Provide feedback via the [GitHub issue tracker](https://github.com/serenadeai/serenade/issues) if you encounter any issues.
|
||||
:::
|
||||
|
||||
To set up hooks, add the following to your Claude Code settings file
|
||||
@@ -235,15 +234,11 @@ In both cases, proceed to enter Serena as the name, then select either global or
|
||||
You should be able to see Serena in the tools overview in the AI Chat window.
|
||||
|
||||
**Hooks.**
|
||||
VSCode's Copilot agent can sometimes over-rely on basic tools like `read_file` and `grep_search` instead of
|
||||
using Serena's more efficient symbolic tools. You can use Serena's hook commands to automatically correct
|
||||
for this — the hooks will simply remind the agent to use Serena's tools when appropriate.
|
||||
Due to recent changes (especially dynamic tool loading) in VSCode, the agent will often fail to make proper use
|
||||
of Serena's tools, either by failing to load them in the beginning or by forgetting the instructions in a long session
|
||||
(a behaviour known as agent drift). To counteract this, we provide reminder hooks. We **strongly recommend** setting
|
||||
up the hooks as below (or a variation thereof) for optimal performance of Serena in VSCode.
|
||||
|
||||
:::{note}
|
||||
Hooks are an **alpha feature** that we provide to overcome context drift in several agent harnesses
|
||||
(where agents, especially those powered by Anthropic models, may forget to load and use MCP tools or
|
||||
fail to read MCP instructions).
|
||||
:::
|
||||
|
||||
The hooks will:
|
||||
|
||||
@@ -301,6 +296,10 @@ The Codex app does not start a session in the project's directory, so when using
|
||||
asking Codex to "Activate the current dir as project using serena" at the start of each session (though Codex might
|
||||
do this automatically).
|
||||
|
||||
**Hooks.** The Codex hook system is less refined than of VSCode or Claude Code, but Codex also displays less drift
|
||||
and is better in using Serena's tools out of the box. If you use the Codex app, you can consider setting up the
|
||||
SessionStart hook (see above) to remind the agent to activate the project directory.
|
||||
|
||||
## Claude Desktop
|
||||
|
||||
On Windows and macOS, there are official [Claude Desktop applications by Anthropic](https://claude.ai/download); for Linux, there is an [open-source
|
||||
|
||||
Reference in new issue
Block a user