Add usage instructions, update edit command, and refine code generation

Author: chand1012

README.md

@@ -54,12 +54,40 @@ otto config --model $MODEL_NAME
 You can add a GitHub Personal Access Token for opening PRs by running:
 
 ```sh
-otto config --token $GITHUB_TOKEN
+otto config --token $GITHUB_TOKEN # Optional. Only needed for opening PRs and reading Issues
 ```
 
 Make sure that your access token has the `repo` scope.
 
-Once that is complete, you can start generating documentation by running the following command:
+Once that is complete, you can start running commands!
+
+## Usage
+
+More detailed usage can be found in the [documentation](https://ottodocs.chand1012.dev/docs/usage/otto).
+
+### Code Generation
+
+![Made with VHS](https://vhs.charm.sh/vhs-5A6u3ITYSIp2qd1T7XdYEM.gif)
+
+Otto can generate code and save it directly to your project! To do this, you can run the following command:
+
+```sh
+otto edit <path to file> -g "Write me a Python function that returns the sum of two numbers"
+```
+
+You can also give Otto additional context to help it generate better code:
+
+```sh
+otto edit <path to file> -g "Write me a Python function that returns the sum of two numbers" -c hello_world.py
+```
+
+Or you can have it use as much of the repo as possible as context:
+
+```sh
+otto edit <path to file> -g "Write me a Python function that returns the sum of two numbers" -r
+```
+
+### Documentation
 
 ```sh
 otto docs <path to repo or file>
@@ -71,6 +99,8 @@ Or for a single file, you can run:
 otto doc -f <path to file>
 ```
 
+### Ask
+
 Ask a question about a repo:
 
 ```sh

cmd/edit.go

@@ -114,6 +114,9 @@ Example: otto edit main.go --start 1 --end 10 --goal "Refactor the function"`,
 			}
 
 			for _, file := range repo.Files {
+				if file.Path == fileName {
+					continue
+				}
 				err = m.Add(file.Path, file.Contents)
 				if err != nil {
 					log.Errorf("Error indexing file: %s", err)
@@ -253,7 +256,7 @@ Example: otto edit main.go --start 1 --end 10 --goal "Refactor the function"`,
 					newMessages = []openai.ChatCompletionMessage{
 						{
 							Role:    openai.ChatMessageRoleUser,
-							Content: "Use the following input to edit the code: " + confirm,
+							Content: "Use the following input to edit the code: " + confirm + "\n\nMake sure to only output the code, do not print anything else.",
 						},
 						{
 							Role:    openai.ChatMessageRoleAssistant,

img/commit.gif

@@ -0,0 +1,11 @@
+Output img/commit.gif
+
+Set Shell "zsh"
+Set FontSize 32
+Set Width 1600
+Set Height 900
+
+Type "otto commit" Sleep 500ms  Enter
+Sleep 5s
+Type "y" Sleep 500ms Enter
+Sleep 1s

img/commit.tape

@@ -0,0 +1,13 @@
+Output img/edit.gif
+
+Set Shell "zsh"
+Set FontSize 32
+Set Width 1600
+Set Height 900
+
+Type "otto edit hello.py -g 'Write me a Python hello world program' " Sleep 500ms  Enter
+Sleep 5s
+Type "Add user input" Sleep 500ms Enter
+Sleep 5s
+Type "y" Sleep 500ms Enter
+Sleep 1s