|
1 | | -Note: This is currently experimental and not for production use! |
| 1 | +# beago: Get feedback on your code before it hits review. |
2 | 2 |
|
3 | | -# Interacting with LLMs in Go has never been easier. |
| 3 | +[](https://opensource.org/licenses/MIT)   |
4 | 4 |
|
5 | | -[](https://opensource.org/licenses/MIT)   |
| 5 | +beago uses Go's own tooling to analyze your code --- the same way Go itself sees it. The result: feedback that's actually relevant to your codebase. |
6 | 6 |
|
7 | | -Meet Gogo the standing chick. 🐥. |
| 7 | +How It Works: |
8 | 8 |
|
9 | | -* Gogo helps you work with LLMs in Go(lang) — without external dependencies |
10 | | -* Gogo keeps your stack lean and efficient |
11 | | -* Gogo can be run everywhere using minimal resources pointing to a LLM |
| 9 | +1. Write your code |
| 10 | +2. Run `beago analyze` to check it against your entire codebase |
| 11 | +3. Adjust before you open the PR |
12 | 12 |
|
13 | | -## Example: |
| 13 | +It's that easy. Stop repeating the same review comments. |
14 | 14 |
|
15 | | -Usage of the `pipe` |
16 | | - |
17 | | -```go |
18 | | -// This is not the full example. See 'examples/pipe' |
19 | | -pipe := pipe.New(messages, ollamaClient, parser) |
20 | | -result, _ := pipe.Invoke(context.Background()) |
21 | | -fmt.Println("Translate from", result.InputLanguage, " to ", result.OutputLanguage) |
22 | | -fmt.Println("Result: ", result.Text) |
23 | | -``` |
24 | | - |
25 | | -## 📚 Sources and Inspiration |
26 | | - |
27 | | -Note, these inspirations have different goals then Gogo but are worth looking into. |
28 | | - |
29 | | -- [tmc/langchaingo](https://github.com/tmc/langchaingo) |
30 | | - |
31 | | -## ✨ Contributors |
32 | | - |
33 | | -<table> |
34 | | - <tr> |
35 | | - <td align="center"> |
36 | | - <img src="https://avatars.githubusercontent.com/tobiasgleiter" width="64px" style="border-radius: 50%;" alt="Contributor Avatar"/> |
37 | | - </td> |
38 | | - <td align="center"> |
39 | | - <img src="https://avatars.githubusercontent.com/u/79313705" width="64px" style="border-radius: 50%;" alt="Contributor Avatar"/> |
40 | | - </td> |
41 | | - <td align="center"> |
42 | | - <img src="https://avatars.githubusercontent.com/u/184933573" width="64px" style="border-radius: 50%;" alt="Contributor Avatar"/> |
43 | | - </td> |
44 | | - <td align="center"> |
45 | | - <img src="https://avatars.githubusercontent.com/u/173567119" width="64px" style="border-radius: 50%;" alt="Contributor Avatar"/> |
46 | | - </td> |
47 | | - </tr> |
48 | | -</table> |
| 15 | +## Contributions |
49 | 16 |
|
50 | 17 | Contributions of any kind are welcome! 🙌 See [Get Involved](/docs/GET-INVOLVED.md) to get started. |
0 commit comments