From ff5ac556dc40309dd4610bd2faa09f9f80c48a71 Mon Sep 17 00:00:00 2001 From: Dominik Jain Date: Sat, 8 Nov 2025 14:14:20 +0100 Subject: [PATCH] Add CLI command examples --- docs/02-usage/020_running.md | 62 +++++++++++++++++++++++++++++++++++- 1 file changed, 61 insertions(+), 1 deletion(-) diff --git a/docs/02-usage/020_running.md b/docs/02-usage/020_running.md index 3f57d77a..1af40b13 100644 --- a/docs/02-usage/020_running.md +++ b/docs/02-usage/020_running.md @@ -41,6 +41,11 @@ Explore the CLI to see some of the customization options that serena provides (m uv run --directory /abs/path/to/serena serena ``` +:::{note} +Adding the `--directory` option results in the working directory being set to the Serena directory. +As a consequence, you will need to specify paths when using CLI commands that would otherwise operate on the current directory. +::: + (docker)= ### Using Docker (Experimental) @@ -158,6 +163,61 @@ To get help on a specific command, run: --help +In general, add `--help` to any command or sub-command to get information about its usage and available options. + Here are some examples of commands you might find useful: - # TODO +```bash +# get help about a sub-command + tools list --help + +# list all available tools + tools list --all + +# get detailed description of a specific tool + tools description find_symbol + +# creating a new Serena project in the current directory + project generate-yml + +# indexing the project in the current directory + project index + +# run a health check on the project in the current directory + project health-check + +# check if a path is ignored by the project + project is_ignored_path path/to/check + +# edit Serena's configuration file + config edit + +# list available contexts + context list + +# create a new context + context create my-custom-context + +# edit a custom context + context edit my-custom-context + +# list available modes + mode list + +# create a new mode + mode create my-custom-mode + +# edit a custom mode + mode edit my-custom-mode + +# list available prompt definitions + prompts list + +# create an override for internal prompts + prompts create-override prompt-name + +# edit a prompt override + prompts edit-override prompt-name +``` + +Explore the full set of commands and options using the CLI itself! \ No newline at end of file