@@ -23,8 +23,9 @@ Binharic is a terminal-based AI coding assistant (a coding agent) similar to Ope
2323Anthropic's Claude Code—but with the personality of a devout Tech-Priest of the Adeptus Mechanicus.
2424Binharic is written in TypeScript and uses the [ AI SDK] ( https://ai-sdk.dev/ ) framework for most of its underlying
2525agentic logic (like tool calling and workflow management).
26- Moreover, its architecture follows the recommendations mentioned in the
27- [ building effective agents] ( https://www.anthropic.com/engineering/building-effective-agents ) from Anthropic.
26+ Additionally, its architecture follows the recommendations mentioned in the
27+ [ building effective agents] ( https://www.anthropic.com/engineering/building-effective-agents ) article from Anthropic,
28+ to a good degree.
2829
2930Binharic's development started as a personal project to learn more about building a terminal-based coding agent.
3031However, the project has grown somewhat into a full-fledged coding assistant with a lot of features
@@ -33,7 +34,7 @@ like the ability to analyze projects, run tests, find bugs, and perform code rev
3334### Features
3435
3536- Can use models from OpenAI, Google, Anthropic, and Ollama
36- - Is fully customizable (like customizing system prompt, models, etc. )
37+ - Is fully customizable (like customizing system prompt)
3738- Comes with a built-in retrieval-augmented generation (RAG) pipeline
3839- Comes with a large set of built-in tools (like reading and writing files); can use external tools via MCP
3940- Comes with built-in workflows for standard software development tasks (like debugging and code review)
@@ -48,7 +49,33 @@ See the [ROADMAP.md](ROADMAP.md) for the list of implemented and planned feature
4849
4950### Getting Started
5051
51- To be added.
52+ You can follow the instructions below to install and use Binharic in your terminal.
53+
54+ #### Installation
55+
56+ ``` sh
57+ npm install -g @cogitator/binharic-cli
58+ ```
59+
60+ #### Usage
61+
62+ ``` sh
63+ # Make sure API keys are available in the environment
64+ export OPENAI_API_KEY=< your-openai-api-key>
65+ export ANTHROPIC_API_KEY=< your-anthropic-api-key>
66+ export GOOGLE_API_KEY=< your-google-api-key>
67+
68+ # Start Binharic in the terminal
69+ binharic
70+ ```
71+
72+ [ ![ asciicast] ( https://asciinema.org/a/vDae95b1lm20X7HGSlcVe3M6C.svg )] ( https://asciinema.org/a/vDae95b1lm20X7HGSlcVe3M6C )
73+
74+ ---
75+
76+ #### Documentation
77+
78+ See the [ docs] ( docs ) for more information on how to use Binharic coding agent.
5279
5380---
5481
0 commit comments