Skip to content

Commit 7c1d0df

Browse files
committed
Simplify the project
1 parent ac77269 commit 7c1d0df

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+153
-13736
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,3 +164,5 @@ coverage/
164164
package-lock.json_
165165
BINHARIC.md
166166
AGENT.md
167+
*.tar.gz
168+
*.tgz

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ Contributions are always welcome and appreciated.
55

66
### How to Contribute
77

8-
Please check the [issue tracker](https://github.com/habedi/tobi/issues) to see if there is an
8+
Please check the [issue tracker](https://github.com/CogitatorTech/binharic-cli/issues) to see if there is an
99
issue you would like to work on or if it has already been resolved.
1010

1111
#### Reporting Bugs
1212

13-
1. Open an issue on the [issue tracker](https://github.com/habedi/tobi/issues).
13+
1. Open an issue on the [issue tracker](https://github.com/CogitatorTech/binharic-cli/issues).
1414
2. Include information such as steps to reproduce the observed behavior and relevant logs or screenshots.
1515

1616
#### Suggesting Features
1717

18-
1. Open an issue on the [issue tracker](https://github.com/habedi/tobi/issues).
18+
1. Open an issue on the [issue tracker](https://github.com/CogitatorTech/binharic-cli/issues).
1919
2. Provide details about the feature, its purpose, and potential implementation ideas.
2020

2121
### Submitting Pull Requests

Makefile

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ check-deps:
2121
fi
2222

2323
# Declare all targets as phony (not files)
24-
.PHONY: help install check-deps test coverage lint lint-fix format typecheck build run clean reset setup-hooks test-hooks
24+
.PHONY: help install check-deps test coverage lint lint-fix format typecheck build run clean reset setup-hooks \
25+
test-hooks npm-login npm-whoami pack pack-dry-run publish publish-dry-run version-patch version-minor version-major
2526

2627
.DEFAULT_GOAL := help
2728

@@ -81,3 +82,33 @@ setup-hooks: ## Install Git hooks (pre-commit and pre-push)
8182
test-hooks: ## Test Git hooks on all files
8283
@echo "Testing Git hooks..."
8384
@pre-commit run --all-files --show-diff-on-failure
85+
86+
# ==============================================================================
87+
# PUBLISHING
88+
# ==============================================================================
89+
npm-login: ## Log in to npm registry
90+
$(PACKAGE_MANAGER) login
91+
92+
npm-whoami: ## Show current npm user (if logged in)
93+
-$(PACKAGE_MANAGER) whoami
94+
95+
pack: build ## Create npm tarball (binharic-cli-<version>.tgz)
96+
$(PACKAGE_MANAGER) pack
97+
98+
pack-dry-run: build ## Preview files that would be packed
99+
$(PACKAGE_MANAGER) pack --dry-run
100+
101+
publish-dry-run: ## Simulate npm publish (no registry changes)
102+
$(PACKAGE_MANAGER) publish --dry-run
103+
104+
publish: ## Publish the package to npm (runs build via prepublishOnly)
105+
$(PACKAGE_MANAGER) publish
106+
107+
version-patch: ## Bump patch version (x.y.z -> x.y.(z+1))
108+
$(PACKAGE_MANAGER) version patch
109+
110+
version-minor: ## Bump minor version (x.y.z -> x.(y+1).0)
111+
$(PACKAGE_MANAGER) version minor
112+
113+
version-major: ## Bump major version ((x+1).0.0)
114+
$(PACKAGE_MANAGER) version major

README.md

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,37 +6,49 @@
66

77
<h2>Binharic</h2>
88

9-
[![Tests](https://img.shields.io/github/actions/workflow/status/habedi/tobi/tests.yml?label=tests&style=flat&labelColor=333333&logo=github&logoColor=white)](https://github.com/habedi/tobi/actions/workflows/tests.yml)
10-
[![Code Coverage](https://img.shields.io/codecov/c/github/habedi/tobi?style=flat&label=coverage&labelColor=333333&logo=codecov&logoColor=white)](https://codecov.io/gh/habedi/tobi)
11-
[![Code Quality](https://img.shields.io/codefactor/grade/github/habedi/tobi?style=flat&label=code%20quality&labelColor=333333&logo=codefactor&logoColor=white)](https://www.codefactor.io/repository/github/habedi/tobi)
9+
[![Tests](https://img.shields.io/github/actions/workflow/status/CogitatorTech/binharic-cli/tests.yml?label=tests&style=flat&labelColor=333333&logo=github&logoColor=white)](https://github.com/CogitatorTech/binharic-cli/actions/workflows/tests.yml)
10+
[![Code Coverage](https://img.shields.io/codecov/c/github/CogitatorTech/binharic-cli?style=flat&label=coverage&labelColor=333333&logo=codecov&logoColor=white)](https://codecov.io/gh/CogitatorTech/binharic-cli)
11+
[![Code Quality](https://img.shields.io/codefactor/grade/github/CogitatorTech/binharic-cli?style=flat&label=code%20quality&labelColor=333333&logo=codefactor&logoColor=white)](https://www.codefactor.io/repository/github/CogitatorTech/binharic-cli)
1212
[![Documentation](https://img.shields.io/badge/docs-latest-8ca0d7?style=flat&labelColor=333333&logo=read-the-docs&logoColor=white)](docs)
1313
[![License](https://img.shields.io/badge/license-MIT-00acc1?style=flat&labelColor=333333&logo=open-source-initiative&logoColor=white)](LICENSE)
1414

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
1616

1717
</div>
1818

1919
---
2020

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.
2229

2330
### Features
2431

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.
3243
3344
---
3445

3546
### Quick Start
3647

3748
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)
4052

4153
Install and run:
4254

@@ -150,9 +162,8 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to make a contribution
150162

151163
### License
152164

153-
This template is licensed under the MIT License (see [LICENSE](LICENSE)).
165+
This project is licensed under the MIT License (see [LICENSE](LICENSE)).
154166

155167
### Acknowledgements
156168

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.

codecov.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/AI_SDK_5_MIGRATION_COMPLETE.md

Lines changed: 0 additions & 211 deletions
This file was deleted.

0 commit comments

Comments
 (0)