From 4972c8b31531e76a1eafad6e7e3550e5b23200da Mon Sep 17 00:00:00 2001 From: Hassan Abedi Date: Wed, 15 Oct 2025 21:18:17 +0200 Subject: [PATCH 1/4] The base commit --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 7e55e71..3f5ae6c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@cogitator/binharic-cli", - "version": "0.1.0-alpha.2", + "version": "0.1.0-alpha.3", "description": "A coding agent with the persona of a Tech-Priest of the Adeptus Mechanicus", "main": "dist/cli.js", "type": "module", From ca11edc9f7d32e67c99e0e85a4268a2fe825d645 Mon Sep 17 00:00:00 2001 From: Hassan Abedi Date: Wed, 15 Oct 2025 21:24:27 +0200 Subject: [PATCH 2/4] Add installation instructions --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 297241a..dfe83b5 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ like the ability to analyze projects, run tests, find bugs, and perform code rev ### Features - Can use models from OpenAI, Google, Anthropic, and Ollama -- Is fully customizable (like customizing system prompt, models, etc.) +- Is fully customizable (like customizing system prompt) - Comes with a built-in retrieval-augmented generation (RAG) pipeline - Comes with a large set of built-in tools (like reading and writing files); can use external tools via MCP - Comes with built-in workflows for standard software development tasks (like debugging and code review) @@ -48,7 +48,31 @@ See the [ROADMAP.md](ROADMAP.md) for the list of implemented and planned feature ### Getting Started -To be added. +You can follow the instructions below to install and use Binharic in your terminal. + +#### Installation + +```sh +npm install -g @cogitator/binharic-cli +``` + +#### Usage + +```sh +# Make sure API keys are available in the environment +export OPENAI_API_KEY= +export ANTHROPIC_API_KEY= +export GOOGLE_API_KEY= + +# Start Binharic in the terminal +binharic +``` + +--- + +#### Documentation + +See the [docs](docs) for more information on how to use Binharic coding agent. --- From 99f754a8e606e5babe2f4748d27577613b7e9597 Mon Sep 17 00:00:00 2001 From: Hassan Abedi Date: Wed, 15 Oct 2025 21:52:29 +0200 Subject: [PATCH 3/4] Add a simple usage demo using Asciinema --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index dfe83b5..b6dbf86 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,8 @@ export GOOGLE_API_KEY= binharic ``` +[![asciicast](https://asciinema.org/a/vDae95b1lm20X7HGSlcVe3M6C.svg)](https://asciinema.org/a/vDae95b1lm20X7HGSlcVe3M6C) + --- #### Documentation From 3371ab2f0705610c91da4b501f6a7c0519c875c1 Mon Sep 17 00:00:00 2001 From: Hassan Abedi Date: Wed, 15 Oct 2025 21:58:12 +0200 Subject: [PATCH 4/4] WIP --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b6dbf86..55ac603 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,9 @@ Binharic is a terminal-based AI coding assistant (a coding agent) similar to Ope Anthropic's Claude Code—but with the personality of a devout Tech-Priest of the Adeptus Mechanicus. Binharic is written in TypeScript and uses the [AI SDK](https://ai-sdk.dev/) framework for most of its underlying agentic logic (like tool calling and workflow management). -Moreover, its architecture follows the recommendations mentioned in the -[building effective agents](https://www.anthropic.com/engineering/building-effective-agents) from Anthropic. +Additionally, its architecture follows the recommendations mentioned in the +[building effective agents](https://www.anthropic.com/engineering/building-effective-agents) article from Anthropic, +to a good degree. Binharic's development started as a personal project to learn more about building a terminal-based coding agent. However, the project has grown somewhat into a full-fledged coding assistant with a lot of features