You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
`ottodocs` is a command-line tool written in Go that uses GPT-3 (and GPT-4 once the API is available) to automatically generate or add inline and markdown documentation for your code. It can parse a git repository or an individual file and create markdown documentation or add inline comments. The tool requires an [OpenAI API key](https://platform.openai.com/account/api-keys) to function.
5
+
OttoDocs is a command-line tool written in Go that uses GPT-3 (and GPT-4 once the API is available) to automatically generate or add inline and markdown documentation for your code. It can parse a git repository or an individual file and create markdown documentation or add inline comments. The tool requires an [OpenAI API key](https://platform.openai.com/account/api-keys) to function.
6
6
7
-
`ottodocs` utilizes the `just` command runner for building and running tasks, making it easy to use and maintain.
7
+
OttoDocs utilizes the `just` command runner for building and running tasks, making maintaining the project easier. If you do not have `just` installed, see [here](https://just.systems/man/en/chapter_5.html) for installation methods.
8
8
9
9
## Installation
10
10
11
-
There are two methods to install `ottodocs`:
11
+
There are two methods to install OttoDocs:
12
12
13
13
1.**Precompiled binaries:** Download the precompiled binaries from the [GitHub releases tab](https://github.com/chand1012/ottodocs/releases).
14
14
2.**Build from source:** Clone the repo and build the binary by running the following commands:
just build # will output binary to bin/otto. Copy the file to a directory in your PATH
19
+
just build # will build to bin/ottodocs
20
+
# or
21
+
just install # will build & copy to $GOPATH/bin.
20
22
```
21
23
24
+
If you want to build for all supported platforms, you can run the following command:
25
+
26
+
```sh
27
+
just crossbuild
28
+
```
29
+
30
+
This will build and compress binaries for all supported platforms and place them in the `dist` directory.
31
+
22
32
## Getting Started
23
33
24
34
First, you need to create an OpenAI API Key. If you do not already have an OpenAI account, you can create a new one and get some free credits to try it out. Once you have an account, you can create an API key by going to the [API Keys tab](https://platform.openai.com/account/api-keys) in your account settings.
@@ -32,7 +42,7 @@ otto login
32
42
Optionally you can pass the API key as an argument to the command:
33
43
34
44
```sh
35
-
otto login -p$OPENAI_API_KEY
45
+
otto login --apikey$OPENAI_API_KEY
36
46
```
37
47
38
48
Once that is complete, you can start generating documentation by running the following command:
0 commit comments