Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BigRedT authored Aug 21, 2024
1 parent d0342ae commit 3995449
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Here's a more detailed description of the arguments you can pass to `codenav que
| `--code_dir` | str | The path to the codebase you want CodeNav to use. By default all files in this directory will get indexed with relative file paths. For instance, if you set `--code_dir /Users/tanmay/codebase` which contains a `computer_vision/tool.py` file then this file will be indexed with relative path `computer_vision/tools.py` |
| `--force_subdir` | str | If you wish to only index a subdirectory within the code_dir then set this to the name of the sub directory |
| `--module` | str | If you have a module installed e.g. via `pip install transformers` and you want CodeNav to use this module, you can simply set `--module transformers` instead of providing `--code_dir` |
| `--repo_description_path` | str | If you have a README file or a file with a description of the codebase you are using, you can provide the path to this file here. You may use this file to point out the libraries high-level purpose and structure of the codebase (e.g. highlight important directories, files, classes or functions) |
| `--repo_description_path` | str | If you have a README file or a file with a description of the codebase you are using, you can provide the path to this file here. You may use this file to point out to CodeNav the high-level purpose and structure of the codebase (e.g. highlight important directories, files, classes or functions) |
| `--force_reindex` | bool | Set this flag if you want to force CodeNav to reindex the codebase. Otherwise, CodeNav will reuse an existing index if it exists or create one if it doesn't |
| `--playground_dir` | str | The path specified here will work as the current directory for CodeNav's execution environment |
| `--query` | str | The query you want CodeNav to solve using the codebase |
Expand Down

0 comments on commit 3995449

Please sign in to comment.