Skip to content

Commit 26dca3b

Browse files
committed
Add AI Sidekick feature description to README.md
1 parent c62896b commit 26dca3b

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,23 @@ It's also not a "build a site for me in 5 minutes" tool that takes a well constr
2020

2121
## Current features - how you can use it today
2222

23+
### AI Sidekick
24+
25+
`aicodebot sidekick` Your AI-powered coding assistant. It's designed to help you with your coding tasks by providing context-aware suggestions and solutions. Think ChatGPT with the ability to read local files for context.
26+
27+
```bash
28+
aicodebot sidekick file1.py file2.py
29+
```
30+
31+
In this example, the sidekick will read in the contents of file1.py and file2.py and use them to provide context-aware answers. For example:
32+
33+
* How can I make this code better?
34+
* Tell me how to add a new feature to this code.
35+
* Fix an issue that I'm having when... (describe the issue)
36+
* Write unit tests for the xyz function.
37+
38+
Please note that this feature is still in its experimental stage. While it can already provide valuable assistance, it's not perfect and we're continuously working on improving it.
39+
2340
### AI-Assisted Git Commit
2441

2542
`aicodebot commit` will run pre-commit for you to check syntax, and then generate a commit message for you based on the changes you've made. In about as much effort as typing "fix bug" for the commit message, you will get a high quality commit message that thoroughly describes the change.

0 commit comments

Comments
 (0)