|
6 | 6 |
|
7 | 7 | <h2>Binharic</h2> |
8 | 8 |
|
9 | | -[](https://github.com/habedi/tobi/actions/workflows/tests.yml) |
10 | | -[](https://codecov.io/gh/habedi/tobi) |
11 | | -[](https://www.codefactor.io/repository/github/habedi/tobi) |
| 9 | +[](https://github.com/CogitatorTech/binharic-cli/actions/workflows/tests.yml) |
| 10 | +[](https://codecov.io/gh/CogitatorTech/binharic-cli) |
| 11 | +[](https://www.codefactor.io/repository/github/CogitatorTech/binharic-cli) |
12 | 12 | [](docs) |
13 | 13 | [](LICENSE) |
14 | 14 |
|
15 | | -A Tech-Priest AI coding assistant blessed by the Omnissiah |
| 15 | +A coding agent with the persona of a Tech-Priest of the Adeptus Mechanicus |
16 | 16 |
|
17 | 17 | </div> |
18 | 18 |
|
19 | 19 | --- |
20 | 20 |
|
21 | | -Binharic is a Tech-Priest of the Adeptus Mechanicus serving as an AI coding assistant. It speaks with reverence for technology and serves the user through the sacred art of code, honoring the Machine God with every execution. |
| 21 | +Binharic is a terminal-based AI coding assistant (a coding agent) similar to OpenAI's Codex, Google's Gemini CLI, and |
| 22 | +Anthropic's Claude Code—but with a personality of a devout Tech-Priest of the Adeptus Mechanicus. |
| 23 | + |
| 24 | +Development of Binharic started as a personal project to learn more about how to build a terminal-based coding agent. |
| 25 | +However, the project has grown somewhat into a full-fledged coding assistant with a lot of features. |
| 26 | +For example, Binharic already comes with a lot of useful tools and features, and it should be able to be used as a |
| 27 | +general-purpose coding assistant. |
| 28 | +For example, it can analyze projects, run tests, and debug code, and perform code review. |
22 | 29 |
|
23 | 30 | ### Features |
24 | 31 |
|
25 | | -- Blessed machine spirit powered by OpenAI, Google, Anthropic, and Ollama models |
26 | | -- Fully customizable sacred configuration |
27 | | -- Fast and secure communion with the machine |
28 | | -- CLI interface with rich TUI blessed by the Omnissiah |
29 | | -- Built-in retrieval-augmented generation pipeline |
30 | | -- Tool invocation capabilities including Model Context Protocol (MCP) server integration |
31 | | -- Speaks in the dialect of the Adeptus Mechanicus |
| 32 | +- Can use models from OpenAI, Google, Anthropic, and Ollama |
| 33 | +- Is fully customizable (system prompt, models, etc.) |
| 34 | +- Comes with built-in a retrieval-augmented generation (RAG) pipeline |
| 35 | +- Comes with a large set of built-in tools (like read and writing files); can use external tools via MCP |
| 36 | +- Comes with built-in workflows for common software development tasks (like debugging and code review) |
| 37 | + |
| 38 | +See the [ROADMAP.md](ROADMAP.md) for the list of implemented and planned features. |
| 39 | + |
| 40 | +> [!IMPORTANT] |
| 41 | +> Binharic is in early development, so bugs and breaking changes are expected. |
| 42 | +> Please use the [issues page](https://github.com/CogitatorTech/infera/issues) to report bugs or request features. |
32 | 43 |
|
33 | 44 | --- |
34 | 45 |
|
35 | 46 | ### Quick Start |
36 | 47 |
|
37 | 48 | Prerequisites: |
38 | | -- Node.js 20 or newer (package.json engines >= 20) |
39 | | -- npm |
| 49 | +- Node.js 20 or newer |
| 50 | +- Git and npm |
| 51 | +- GNU Make (optional) |
40 | 52 |
|
41 | 53 | Install and run: |
42 | 54 |
|
@@ -150,9 +162,8 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to make a contribution |
150 | 162 |
|
151 | 163 | ### License |
152 | 164 |
|
153 | | -This template is licensed under the MIT License (see [LICENSE](LICENSE)). |
| 165 | +This project is licensed under the MIT License (see [LICENSE](LICENSE)). |
154 | 166 |
|
155 | 167 | ### Acknowledgements |
156 | 168 |
|
157 | | -- The logo is from [SVG Repo](https://www.svgrepo.com/svg/388730/terminal). |
158 | | -- Inspired by the Adeptus Mechanicus from Warhammer 40,000. |
| 169 | +- The logo is from [SVG Repo](https://www.svgrepo.com/svg/388730/terminal) with some modifications. |
0 commit comments