Skip to content

Commit 968df5c

Browse files
committed
Update docs
1 parent 88f38c5 commit 968df5c

12 files changed

+76
-30
lines changed

docs/otto.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,15 @@ otto [flags]
2020
### SEE ALSO
2121

2222
* [otto ask](otto_ask.md) - Ask a question about a file or repo
23-
* [otto chat](otto_chat.md) - Talk with ChatGPT from the command line!
24-
* [otto cmd](otto_cmd.md) - Have ChatGPT suggest a command to run next
23+
* [otto chat](otto_chat.md) - Talk with Otto from the command line!
24+
* [otto cmd](otto_cmd.md) - Have Otto suggest a command to run next
2525
* [otto commit](otto_commit.md) - Generates a commit message from the git diff
2626
* [otto config](otto_config.md) - Configures ottodocs
2727
* [otto docs](otto_docs.md) - Document a repository of files or a single file
28-
* [otto issue](otto_issue.md) - Get a prompt for or ask ChatGPT about a GitHub Issue.
28+
* [otto edit](otto_edit.md) - Edit a file using AI
29+
* [otto issue](otto_issue.md) - Get a prompt for or ask Otto about a GitHub Issue.
2930
* [otto pr](otto_pr.md) - Generate a pull request
30-
* [otto prompt](otto_prompt.md) - Generates a ChatGPT prompt from a given Git repo
31+
* [otto prompt](otto_prompt.md) - Generates a Otto prompt from a given Git repo
3132
* [otto version](otto_version.md) - Prints version information.
3233

33-
###### Auto generated by spf13/cobra on 26-Apr-2023
34+
###### Auto generated by spf13/cobra on 30-Apr-2023

docs/otto_ask.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ otto ask [flags]
3131

3232
* [otto](otto.md) - Document your code with ease
3333

34-
###### Auto generated by spf13/cobra on 26-Apr-2023
34+
###### Auto generated by spf13/cobra on 30-Apr-2023

docs/otto_chat.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## otto chat
22

3-
Talk with ChatGPT from the command line!
3+
Talk with Otto from the command line!
44

55
### Synopsis
66

7-
Talk with ChatGPT from the command line!
7+
Talk with Otto from the command line!
88
No code context is passed in this mode. Emulates web chat.
99

1010
```
@@ -28,4 +28,4 @@ otto chat [flags]
2828

2929
* [otto](otto.md) - Document your code with ease
3030

31-
###### Auto generated by spf13/cobra on 26-Apr-2023
31+
###### Auto generated by spf13/cobra on 30-Apr-2023

docs/otto_cmd.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## otto cmd
22

3-
Have ChatGPT suggest a command to run next
3+
Have Otto suggest a command to run next
44

55
### Synopsis
66

7-
Have ChatGPT suggest a command to run next. This command will use your shell history to suggest a command to run next.
7+
Have Otto suggest a command to run next. This command will use your shell history to suggest a command to run next.
88
This command is only supported on MacOS and Linux using Bash or Zsh. Windows and other shells coming soon!
99

1010
```
@@ -29,4 +29,4 @@ otto cmd [flags]
2929

3030
* [otto](otto.md) - Document your code with ease
3131

32-
###### Auto generated by spf13/cobra on 26-Apr-2023
32+
###### Auto generated by spf13/cobra on 30-Apr-2023

docs/otto_commit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ otto commit [flags]
1515
```
1616
-a, --auto automatically add all and commit with the generated message
1717
-c, --conventional use conventional commits
18+
-f, --force skip confirmation
1819
-h, --help help for commit
19-
-p, --plain no output formatting
2020
--push automatically push to the current branch
2121
-v, --verbose verbose output
2222
```
@@ -31,4 +31,4 @@ otto commit [flags]
3131

3232
* [otto](otto.md) - Document your code with ease
3333

34-
###### Auto generated by spf13/cobra on 26-Apr-2023
34+
###### Auto generated by spf13/cobra on 30-Apr-2023

docs/otto_config.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,17 @@ Configures ottodocs
44

55
### Synopsis
66

7-
Configures ottodocs. Allows user to specify API Keys and the model with a single command.
7+
Configures ottodocs. Allows user to specify OpenAI API Key, GitHub Token, and the model with a single command.
88

9-
Default model is gpt-3.5-turbo.
10-
Valid models are: gpt-4, gpt-4-0314, gpt-4-32k, gpt-4-32k-0314, gpt-3.5-turbo, gpt-3.5-turbo-0301
9+
Default model is gpt-3.5-turbo.
10+
Valid models are: gpt-4, gpt-4-0314, gpt-4-32k, gpt-4-32k-0314, gpt-3.5-turbo, gpt-3.5-turbo-0301
1111
See here for more information on the Models available: https://platform.openai.com/docs/models/model-endpoint-compatibility
1212

13+
GitHub Tokens need access to the repo scope.
14+
15+
OpenAI API Key Generation: https://platform.openai.com/account/api-keys
16+
GitHub Token Generation: https://github.com/settings/tokens
17+
1318

1419
```
1520
otto config [flags]
@@ -34,4 +39,4 @@ otto config [flags]
3439

3540
* [otto](otto.md) - Document your code with ease
3641

37-
###### Auto generated by spf13/cobra on 26-Apr-2023
42+
###### Auto generated by spf13/cobra on 30-Apr-2023

docs/otto_docs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ otto docs [flags]
2525
-m, --markdown Output in Markdown format
2626
-o, --output string Path to the output file. For use with --markdown
2727
-w, --overwrite Overwrite the original file
28-
-p, --prompt string Prompt to use for the ChatGPT API
28+
-p, --prompt string Prompt to use for the Otto API
2929
-v, --verbose Enable verbose logging
3030
```
3131

@@ -39,4 +39,4 @@ otto docs [flags]
3939

4040
* [otto](otto.md) - Document your code with ease
4141

42-
###### Auto generated by spf13/cobra on 26-Apr-2023
42+
###### Auto generated by spf13/cobra on 30-Apr-2023

docs/otto_edit.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## otto edit
2+
3+
Edit a file using AI
4+
5+
### Synopsis
6+
7+
OttoDocs Edit allows you to use AI to help edit your code files.
8+
Provide a file name and a goal, and OttoDocs will return a generated version of the file.
9+
You can even specify the starting and ending lines for the edit, or choose to append the results to the file:
10+
11+
Example: otto edit main.go --start 1 --end 10 --goal "Refactor the function"
12+
13+
```
14+
otto edit [flags]
15+
```
16+
17+
### Options
18+
19+
```
20+
-a, --append Append to the end of a file instead of overwriting it
21+
-e, --end int End line
22+
-f, --force Force overwrite of existing files
23+
-g, --goal string Goal of the edit
24+
-h, --help help for edit
25+
-s, --start int Start line (default 1)
26+
-v, --verbose Verbose output
27+
```
28+
29+
### Options inherited from parent commands
30+
31+
```
32+
-V, --version print version
33+
```
34+
35+
### SEE ALSO
36+
37+
* [otto](otto.md) - Document your code with ease
38+
39+
###### Auto generated by spf13/cobra on 30-Apr-2023

docs/otto_issue.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## otto issue
22

3-
Get a prompt for or ask ChatGPT about a GitHub Issue.
3+
Get a prompt for or ask Otto about a GitHub Issue.
44

55
### Synopsis
66

7-
Get a prompt for or ask ChatGPT about a GitHub Issue. Uses the current working directory's repo by default.
7+
Get a prompt for or ask Otto about a GitHub Issue. Uses the current working directory's repo by default.
88

99
```
1010
otto issue [flags]
@@ -17,8 +17,8 @@ otto issue [flags]
1717
--count count the number of tokens
1818
-h, --help help for issue
1919
-n, --number int the number of the issue to get
20-
-p, --prompt-only only generate a prompt, don't ask ChatGPT
21-
-q, --question string the question to ask ChatGPT
20+
-p, --prompt-only only generate a prompt, don't ask Otto
21+
-q, --question string the question to ask Otto
2222
-v, --verbose verbose output
2323
```
2424

@@ -32,4 +32,4 @@ otto issue [flags]
3232

3333
* [otto](otto.md) - Document your code with ease
3434

35-
###### Auto generated by spf13/cobra on 26-Apr-2023
35+
###### Auto generated by spf13/cobra on 30-Apr-2023

docs/otto_pr.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ otto pr [flags]
1515

1616
```
1717
-b, --base string Base branch to create the pull request against
18+
-f, --force Force the creation of the pull request
1819
-h, --help help for pr
1920
-p, --publish Create the pull request. Must have a remote named "origin"
2021
-r, --remote string Remote for creating the pull request. Only works with GitHub. (default "origin")
@@ -32,4 +33,4 @@ otto pr [flags]
3233

3334
* [otto](otto.md) - Document your code with ease
3435

35-
###### Auto generated by spf13/cobra on 26-Apr-2023
36+
###### Auto generated by spf13/cobra on 30-Apr-2023

0 commit comments

Comments
 (0)