mirror of
https://github.com/tiennm99/serena.git
synced 2026-10-16 10:15:17 +00:00
feat: Added project create command with --name, --index, and auto-creation (#755)
Previous command `generate_yml` has been removed
This commit is contained in:
5 files changed
+347
-21
No files matched your search
@@ -178,9 +178,12 @@ Here are some examples of commands you might find useful:
|
||||
<serena> tools description find_symbol
|
||||
|
||||
# creating a new Serena project in the current directory
|
||||
<serena> project generate-yml
|
||||
<serena> project create
|
||||
|
||||
# indexing the project in the current directory
|
||||
# creating and immediately indexing a project
|
||||
<serena> project create --index
|
||||
|
||||
# indexing the project in the current directory (auto-creates if needed)
|
||||
<serena> project index
|
||||
|
||||
# run a health check on the project in the current directory
|
||||
|
||||
@@ -22,17 +22,19 @@ You can create a project either
|
||||
|
||||
To explicitly create a project, use the following command while in the project directory:
|
||||
|
||||
<serena> project generate-yml [options]
|
||||
<serena> project create [options]
|
||||
|
||||
For instance, when using `uvx`, run
|
||||
|
||||
uvx --from git+https://github.com/oraios/serena serena project generate-yml [options]
|
||||
uvx --from git+https://github.com/oraios/serena serena project create [options]
|
||||
|
||||
* For an empty project, you will need to specify the programming language
|
||||
(e.g., `--language python`).
|
||||
* For an existing project, the main programming language will be detected automatically,
|
||||
but you can choose to explicitly specify multiple languages by passing the `--language` parameter
|
||||
multiple times (e.g. `--language python --language typescript`).
|
||||
* You can optionally specify a custom project name with `--name "My Project"`.
|
||||
* You can immediately index the project after creation with `--index`.
|
||||
|
||||
After creation, you can adjust the project settings in the generated `.serena/project.yml` file.
|
||||
|
||||
|
||||
@@ -22,13 +22,8 @@ Serena is configured in four places:
|
||||
See for a detailed explanation. You can override all entries from the `serena_config.yml` through command line arguments.
|
||||
3. In the `.serena/project.yml` file within your project. This will hold project-level configuration that is used whenever
|
||||
that project is activated. This file will be autogenerated when you first use Serena on that project, but you can also
|
||||
generate it explicitly with
|
||||
|
||||
```shell
|
||||
uvx --from git+https://github.com/oraios/serena serena project generate-yml
|
||||
```
|
||||
|
||||
(or use the `--directory` command version).
|
||||
create it explicitly with `serena project create [options]` (see the [Project Workflow](040_workflow.md#project-creation--indexing)
|
||||
for details on available options).
|
||||
4. Through the context and modes (see below).
|
||||
|
||||
After the initial setup, continue with one of the sections below, depending on how you
|
||||
|
||||
Reference in new issue
Block a user