harubashi 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,293 @@
+🌍 **Read in:** [English](README.md) | [Русский](README.ru.md)
+
+# 🌉 Harubashi
+
+**A headless, multi-profile system-use AI agent — installable as a global npm package.**
+
+[![npm version](https://img.shields.io/npm/v/harubashi.svg?style=flat-square)](https://www.npmjs.com/package/harubashi)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
+[![Node](https://img.shields.io/node/v/harubashi.svg?style=flat-square)](https://nodejs.org)
+
+Harubashi turns your terminal — and your Telegram chat — into a thinking interface to your machine. It executes shell commands, reads files, manages git, and grows with hot-reloadable skills you can write yourself in plain Markdown.
+
+---
+
+## ✨ Why Harubashi?
+
+- **🔁 Multi-profile** — keep separate profiles for work, personal, experiments. Each profile has its own provider, API keys, model, and SQLite database. Switch with one command.
+- **🧠 Skills as Markdown** — drop a `.md` file into `~/.harubashi/skills/` and the agent picks it up instantly via hot-reload. Two kinds: **Tools** (callable functions) and **Guidance** (system-prompt augmentation).
+- **🔐 Secret-masked logs** — Winston file logs redact NVIDIA / OpenAI / Anthropic / Google keys, Telegram bot tokens, and Bearer headers automatically. Daily rotation, 14-day retention.
+- **📡 Telegram-ready** — run `harubashi daemon` and chat with your machine from your phone. Or stay in the terminal with `harubashi cli`.
+- **🛡 Auto-healing** — accidentally delete `~/.harubashi/skills/`? The next daemon boot restores the bundled skills automatically.
+
+---
+
+## 📦 Installation
+
+```bash
+npm install -g harubashi
+```
+
+Requires **Node.js ≥ 18**. The first time you launch any command after install, run the setup wizard:
+
+```bash
+harubashi setup
+```
+
+This creates `~/.harubashi/` containing:
+
+```
+~/.harubashi/
+├── config.yaml          # All profiles + active selection
+├── databases/           # One SQLite file per profile
+│   └── default.db
+├── skills/              # Hot-reloadable Markdown skills
+│   ├── system_execute_command.md
+│   ├── system_read_file.md
+│   ├── directory_explorer.md     (guidance)
+│   └── git_manager.md            (guidance)
+└── logs/                # Daily-rotated JSON logs
+    └── harubashi-YYYY-MM-DD.log
+```
+
+---
+
+## 🚀 Quick Start
+
+```bash
+# 1. Configure your first profile (interactive wizard)
+harubashi setup
+
+# 2. Talk to the agent in your terminal
+harubashi cli
+
+# 3. Or run as a Telegram daemon (background)
+harubashi daemon
+
+# 4. Tail the logs from another terminal
+harubashi logs
+```
+
+The wizard asks for your LLM provider (Nvidia NIM, Google Gemini, with Anthropic / OpenAI / Proxy coming soon), an API key, a model, and optionally a Telegram bot token.
+
+---
+
+## 👤 Profiles
+
+A **profile** is a complete agent identity: provider, credentials, model, optional Telegram bot, and a dedicated SQLite database.
+
+```bash
+harubashi profile list           # Show all profiles, mark the active one
+harubashi profile use work       # Switch active profile
+harubashi profile create staging # Wizard with pre-fill from active profile
+harubashi profile edit work      # Wizard, but skips DB init (config-only edit)
+```
+
+The **edit flow is instant** — if `~/.harubashi/databases/<name>.db` already exists, the wizard skips the Prisma init step. The **create flow is rollback-safe** — if database initialization fails, the profile is *not* added to `config.yaml`.
+
+Re-running `harubashi setup` when a config exists shows a unified picker:
+
+```
+? Select profile to configure:
+  [+] Create new profile...
+❯ work (active)  · nvidia · meta/llama-3.1-70b-instruct
+  staging        · google · gemini-1.5-pro
+```
+
+---
+
+## 🧩 Skills
+
+Skills are Markdown files in `~/.harubashi/skills/`. Each one has a YAML frontmatter and a body. There are **two kinds**:
+
+### Active Tool — `input_schema` is **present**
+
+The skill is registered as a callable LLM function. The body becomes the tool's documentation in the system prompt.
+
+```markdown
+---
+name: system_execute_command
+description: Execute a shell command on the host OS.
+input_schema:
+  type: object
+  properties:
+    command:
+      type: string
+      description: The shell command to execute
+  required: [command]
+---
+
+## Usage Guidelines
+
+- Prefer simple commands over complex pipelines.
+- Always specify `workdir` when operating on a project.
+- Never run destructive commands without explicit user confirmation.
+```
+
+### Guidance-only — `input_schema` is **absent**
+
+The skill is **not** exposed as a tool, but its body is concatenated into the agent's system prompt under `## Guidance: <name>`. Use this to teach the agent how to wield existing tools.
+
+```markdown
+---
+name: git_manager
+description: Workflow guidance for using Git via system_execute_command.
+---
+
+## The mandatory workflow
+
+1. **`git status`** — understand state before any mutation.
+2. **`git diff`** — inspect changes.
+3. **`git add <path>`** — stage selectively.
+4. **`git commit -m "..."`** — Conventional Commits style.
+```
+
+### Built-in skills
+
+| Name                       | Kind     | Purpose                                               |
+|----------------------------|----------|-------------------------------------------------------|
+| `system_execute_command`   | Tool     | Run shell commands cross-platform                     |
+| `system_read_file`         | Tool     | Read a file by absolute path                          |
+| `directory_explorer`       | Guidance | Safe, shallow-first FS exploration; ignore heavy dirs |
+| `git_manager`              | Guidance | Status → diff → add → commit; forbid destructive ops  |
+
+### Manage skills
+
+```bash
+harubashi skills list   # Pretty-print all skills, split by Tools / Guidance
+harubashi skills open   # Open ~/.harubashi/skills/ in the OS file manager
+```
+
+Edit any `.md` file → the running daemon picks up the change instantly via chokidar hot-reload.
+
+### Auto-heal
+
+If you delete `~/.harubashi/skills/` (or it ends up empty), the next daemon boot **restores the bundled skills** from the npm package automatically:
+
+```
+[SkillsService] Auto-healed skills from bundled package (4 file(s)) into ~/.harubashi/skills/
+```
+
+This means the daemon is hard to break. Bundled skills are read-only sources; user edits live in the home directory.
+
+---
+
+## 📜 Logs
+
+```bash
+harubashi logs                     # Tail the latest log file
+harubashi logs --no-follow         # Print and exit
+harubashi logs --lines 200         # 200 lines of history before tailing
+```
+
+- **File format**: line-delimited JSON, one record per line. Daily rotation (`harubashi-YYYY-MM-DD.log`), 14-day retention, 20 MB cap per file.
+- **Console rendering**: pretty-printed, colored by level: `INFO` green, `WARN` yellow, `ERROR` red, `DEBUG` blue.
+- **Secret masking**: API keys (`nvapi-***`, `sk-***`, `AIza***`), Telegram bot tokens, and `Bearer` headers are redacted in **both** transports.
+- **Cross-platform tail**: implemented via `chokidar` instead of `tail -f`, so it works the same on Windows / macOS / Linux. Day-rollover is detected automatically.
+
+---
+
+## ⚙️ Configuration
+
+The single source of truth is `~/.harubashi/config.yaml`. Find its absolute path:
+
+```bash
+harubashi config path
+```
+
+This emits the bare path (no decoration), so it pipes cleanly:
+
+```bash
+code "$(harubashi config path)"             # open in VS Code
+cd "$(dirname "$(harubashi config path)")"  # cd into ~/.harubashi
+```
+
+Schema (abbreviated):
+
+```yaml
+activeProfile: work
+profiles:
+  work:
+    llmProvider: nvidia               # nvidia | google | anthropic | openai | proxy
+    providers:
+      nvidia:
+        apiKey: nvapi-***
+        model: meta/llama-3.1-70b-instruct
+    telegram:
+      enabled: true
+      botToken: ***
+  staging:
+    llmProvider: google
+    providers:
+      google:
+        apiKey: AIza***
+        model: gemini-1.5-pro
+```
+
+Manual edits are fine; the wizard simply automates them.
+
+---
+
+## 📚 Command Reference
+
+| Command                       | Purpose                                                              |
+|-------------------------------|----------------------------------------------------------------------|
+| `harubashi setup`             | First-time wizard, or pick-existing-or-create when config exists     |
+| `harubashi cli`               | Launch the interactive REPL                                          |
+| `harubashi daemon`            | Launch the Telegram-facing background daemon                         |
+| `harubashi logs [opts]`       | Tail the daily log; `-n <N>`, `--no-follow`                          |
+| `harubashi profile list`      | List profiles, mark the active one                                   |
+| `harubashi profile use <name>`| Switch active profile                                                |
+| `harubashi profile create [name]` | Wizard for a new profile (rollback-safe, pre-fill from active)   |
+| `harubashi profile edit [name]`   | Edit an existing profile (skips DB init when DB exists)          |
+| `harubashi skills list`       | List installed skills, split by Tools and Guidance                   |
+| `harubashi skills open`       | Open `~/.harubashi/skills/` in the OS file manager                   |
+| `harubashi config path`       | Print the absolute path to `config.yaml` (pipeable)                  |
+| `harubashi -V` / `--version`  | Print the package version                                            |
+
+---
+
+## 🏗 Architecture
+
+- **NestJS standalone application** — no HTTP server; the agent runs as a context held by `cli` or `daemon`.
+- **Prisma + SQLite** — one database per profile under `~/.harubashi/databases/<name>.db`. Schema bundled with the npm package.
+- **Telegraf** — Telegram bot integration (optional, daemon-only).
+- **chokidar** — file-watching for skills hot-reload and the cross-platform log tail.
+- **Winston + winston-daily-rotate-file** — colored console + JSON file logs with secret masking.
+- **Commander** — CLI surface, lazy dynamic imports per subcommand for fast cold-start.
+- **Inquirer** — interactive wizards for setup and profile management.
+
+---
+
+## 🛠 Development
+
+```bash
+git clone https://github.com/Hilrein/harubashi.git
+cd harubashi
+npm install
+npm run build
+
+# Local beta-test as if it were globally installed
+npm link
+harubashi setup
+```
+
+Useful scripts:
+
+```bash
+npm run build           # nest build
+npm run lint            # eslint
+npm run format          # prettier
+npm run cli             # ts-node src/bin.ts cli
+npm run daemon          # ts-node src/bin.ts daemon
+```
+
+---
+
+## 📄 License
+
+MIT — see [LICENSE](LICENSE).
+
+---
+
+<sub>Made with care. Open an issue if anything feels rough.</sub>