@terminai/core 0.26.0 → 0.50.0

package/LICENSE

@@ -0,0 +1,247 @@
+                                 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.
+
+===============================================================================
+TRADEMARK NOTICE
+===============================================================================
+
+"TerminaI" is a trademark of Prof-Harita (Nittala Venkata Sastry).
+
+While the SOURCE CODE in this repository is licensed under the Apache License
+2.0 (as stated above), the TERMINAI NAME, LOGO, and BRAND IDENTITY are NOT
+licensed for unrestricted use.
+
+The Apache 2.0 license grants you rights to use, modify, and distribute the
+code. However, it does NOT grant trademark rights. Section 6 of the Apache
+License explicitly states: "This License does not grant permission to use the
+trade names, trademarks, service marks, or product names of the Licensor."
+
+PERMITTED TRADEMARK USES:
+
+- Referring to the TerminaI project in documentation or articles
+- Linking to the official TerminaI repository
+- Academic, educational, or press references to TerminaI
+- Stating that your work is "based on TerminaI" or "compatible with TerminaI"
+
+PROHIBITED TRADEMARK USES (without written permission):
+
+- Using "TerminaI" as the name of a competing product or service
+- Using the TerminaI logo or brand assets in your product
+- Creating confusion about whether your product is the official TerminaI
+- Implying endorsement or official status without permission
+
+FORKS AND DERIVATIVE WORKS:
+If you create a fork or derivative work (which the Apache 2.0 license permits),
+you MUST:
+
+- Use a different name (e.g., "MyTerminal" or "MyTerminal based on TerminaI")
+- Not use the TerminaI logo or brand identity
+- Clearly state that it is a fork/derivative and not official
+- Follow all Apache 2.0 license requirements for the code
+
+COMMERCIAL TRADEMARK LICENSING:
+For commercial use of the TerminaI trademark, custom licensing, or partnership
+inquiries, please contact: prof.harita@gmail.com
+
+See TRADEMARK.md for complete trademark usage guidelines.
+
+===============================================================================

package/README.md

@@ -0,0 +1,422 @@
+# TerminAI
+
+### The safe, local-first AI operator for your terminal.
+
+**Stop copy-pasting from ChatGPT.** TerminAI is the CLI that operates your
+machine with permissions you control.
+
+Runs on Windows/Linux/macOS using the models you already trust (Gemini, OpenAI,
+Local LLMs). Designed for real system changes or user workflows - governed,
+reviewable, and reversible.
+
+<div align="center">
+  <img src="docs-terminai/assets/terminai-banner.svg" alt="TerminAI Banner" width="100%">
+</div>
+
+<p align="center">
+  <a href="https://github.com/Prof-Harita/terminaI/actions/workflows/ci.yml"><img src="https://github.com/Prof-Harita/terminaI/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <img src="https://img.shields.io/badge/Node.js-20+-339933" alt="Node.js 20+">
+  <img src="https://img.shields.io/badge/License-Apache%202.0-green" alt="License">
+</p>
+
+**TerminAI is an AI-powered system operator.**  
+You describe what you want; TerminAI inspects your machine, proposes a plan, and
+executes it through **governed tools** with a deterministic **approval ladder**
+and an **audit trail**.
+
+> **Status: Public Preview (v0.x)**  
+> The core operator loop is rock-solid. CLI is the canonical surface.
+> Desktop/Voice/A2A are optional and still being hardened across platforms.
+> Expect power; expect rough edges. Contributions welcome.
+
+---
+
+## What this is / what this is not
+
+**This is:**
+
+- A **local-first operator runtime**: intent → governed plan → approvals →
+  execution → audit log.
+- A **real terminal operator** (true PTY): it can handle interactive sessions
+  (sudo prompts, ssh, vim/htop-style flows).
+- A **model-flexible** setup: choose a provider you already use (including
+  OpenAI-compatible endpoints and local gateways).
+- **100% free and 100% private** if you want it to be. Use free models on
+  OpenRouter, run local LLMs—no telemetry, no charges, ever.
+
+**This is not:**
+
+- A hosted service. There is **no "contact sales," no pilots, no managed
+  deployment**, and no support obligations—this is best-effort OSS.
+- An "unchecked agent" that silently runs commands. Risky actions are gated
+  behind explicit approvals and logged locally.
+- A promise that every surface is production-hardened today
+  (desktop/voice/remote features are optional previews).
+
+---
+
+## Demo
+
+<div align="center">
+  <img src="docs-terminai/assets/Kooha_combined_cropped.gif" alt="TerminAI Demo" width="100%">
+</div>
+
+---
+
+## Try it right now (10 min)
+
+Pick one of these prompts and paste it into TerminAI. _(Click to copy the full
+prompt)_
+
+<details>
+<summary><strong>🌍 1. Plan a complex trip (Research & Output)</strong></summary>
+
+> "Plan an itinerary for Paris. I am visiting as a tourist for 2 days next
+> Saturday. I have already seen the big attractions (Eiffel, Louvre). Find me
+> hidden gems and plan my trip hour-by-hour, including restaurants. Show it on a
+> map. I will visit all these locations via the Metro. Once done, save the
+> map-based visual output as a PDF."
+
+</details>
+
+<details>
+<summary><strong>🔧 2. Fix broken drivers (System Repair)</strong></summary>
+
+> "My graphics drivers seem unstable after the last OS update. Identify my GPU
+> model, check the currently installed driver version, and find the correct
+> latest stable driver. Propose a clean install plan and verify it before
+> execution."
+
+</details>
+
+<details>
+<summary><strong>📈 3. Monitor & Automate (Background Tasks)</strong></summary>
+
+> "Check the price of Bitcoin every 10 minutes. If it drops below $90,000, send
+> a system notification and append the timestamp/price to `~/crypto_log.csv`.
+> Keep running this in the background until I stop it."
+
+</details>
+
+---
+
+## Vision
+
+What if your computer could do things for you safely?
+
+Not just suggesting commands. Not just generating scripts. Actually operating
+your system—diagnosing issues, fixing problems, and orchestrating
+workflows—**with guardrails that make execution trustworthy.**
+
+For years, "internet help" meant: copy instructions from a chat window, paste
+into your terminal, and hope you didn't miss a step. Coding tools (Cursor,
+Aider, etc.) reduced that friction for software development—but the rest of your
+computer is still stuck in the copy/paste era.
+
+TerminAI is the next interface: you state intent, it proposes a governed plan,
+you approve at the right level, and it executes with an audit trail. Fewer
+fragile steps. More outcomes—without handing your machine to an unchecked agent.
+
+---
+
+## Why this exists
+
+Computers are powerful, but operating them still requires memorizing syntax,
+hunting through logs, and repeating the same diagnosis steps.
+
+TerminAI compresses the gap between **intent** and **execution**—without turning
+your machine into an uncontrolled "agent."
+
+**Intent → Governed plan → Approval → Execution → Audit**
+
+---
+
+## Who it's for
+
+- **Generalist users** — “Review the largest files in my downloads folder,
+  prioritizing the oldest first, i need to free up 200 GB of space.” “What is
+  wrong with my internet; reset my adapter.” “Setup a HP printer.” "Monitor the
+  stock price of NVDA and alert me when it hits xx$". "Why is my system so slow?
+  Can you free up memory" "Can you install the best markdown viewer on my linux
+  machine?". "I just re-installed Windows. Find specific drivers for my GPU and
+  install them".
+- **Developers** — “Set up my machine for this repo.” “Fix my dev environment.”
+  “Explain what broke and how to recover.” "Install all the dependencies for
+  this project"
+- **Tech purists** — AI leverage with deterministic guardrails, explicit
+  approvals, and tamper-evident logs.
+- **Professional engineers / DevOps** — Remotely control your servers,
+  repeatable workflows, headless-friendly CLI, safer execution, readable audit
+  trails.
+
+---
+
+## Two ways to use TerminAI
+
+- **CLI (canonical):** for developers, power users, and headless environments.
+- **Desktop (preview):** a Tauri wrapper around the same engine (GUI + voice
+  surface). Linux/Windows are early; macOS is in progress. Treat as experimental
+  until hardened.
+
+The canonical command is: `terminai`.
+
+---
+
+## What makes TerminAI different
+
+AI system operation must be governed. TerminAI is built around that primitive.
+
+- **True PTY support:** handles interactive applications correctly (sudo
+  prompts, ssh sessions, vim/htop-like flows) via `node-pty`.
+- **Governed autonomy:** a strict **policy engine** + deterministic **approval
+  ladder** (A/B/C) replaces "yolo execution."
+- **Audit trail by default:** structured **JSONL** logs for actions and intent
+  tracking (local files you can review/replay).
+- **Provider flexibility:** choose what you already use—Google, OpenAI sign-in,
+  or any OpenAI-compatible `/chat/completions` endpoint (OpenRouter, local
+  gateways, etc.).
+- **Deep extensibility:** first-class support for **MCP** (tool connectors) and
+  an optional **Agent-to-Agent (A2A)** control plane (preview).
+- **Local-first posture:** core operation runs on your machine; no hosted relay
+  is required. Any optional remote features are opt-in and under your control.
+
+## Read more: `docs-terminai/why-terminai.md`
+
+## Install
+
+### CLI (npm)
+
+Prereqs: Node.js 20+
+
+```bash
+npm i -g @terminai/cli
+terminai --version
+terminai
+```
+
+> If you don't see the CLI package yet (or want bleeding-edge), install from
+> source below.
+
+### Desktop (installers) — preview
+
+Download installers from GitHub Releases (desktop is in preview):
+
+- https://github.com/Prof-Harita/terminaI/releases
+
+---
+
+### Git clone and build (contributors / bleeding-edge)
+
+```bash
+git clone https://github.com/Prof-Harita/terminaI.git
+cd terminaI
+npm install
+npm run build
+```
+
+---
+
+## Upgrade (if you installed earlier)
+
+If you installed before the recent multi-provider updates, upgrade so you get
+the latest auth + platform parity.
+
+- **npm global:**
+  ```bash
+  npm i -g @terminai/cli@latest
+  terminai --version
+  ```
+- **release installers:** grab the latest from Releases and reinstall:
+  - https://github.com/Prof-Harita/terminaI/releases
+- **source build:**
+  ```bash
+  git pull
+  npm install
+  npm run build
+  ```
+
+---
+
+## Quick start (providers)
+
+Run `terminai` and the wizard guides you through setup.
+
+### Google Gemini (default)
+
+Fastest path for many users.
+
+```bash
+terminai
+# Select "Google Gemini" → browser opens → sign in
+```
+
+Or use an API key:
+
+```bash
+# macOS/Linux
+export TERMINAI_API_KEY="your-gemini-key"
+
+# Windows (PowerShell)
+$env:TERMINAI_API_KEY='your-gemini-key'
+
+terminai
+```
+
+### ChatGPT sign-in (OAuth) — preview
+
+Use an OpenAI browser sign-in flow (similar to how Codex tooling supports "Sign
+in with ChatGPT").
+
+```bash
+terminai
+# Select "ChatGPT Sign-in (OAuth)" → sign in with OpenAI
+```
+
+> Note: this is still being hardened. If anything fails, attach logs (see below)
+> and open an issue.
+
+### OpenAI-Compatible
+
+Connect to OpenAI Platform, OpenRouter, Ollama gateways, or any
+`/chat/completions` endpoint.
+
+```bash
+# macOS/Linux
+export OPENAI_API_KEY="sk-..."
+
+# Windows (PowerShell)
+$env:OPENAI_API_KEY='sk-...'
+
+terminai
+# Select "OpenAI Compatible" → enter base URL and model
+```
+
+**Popular configurations:**
+
+- OpenAI: `https://api.openai.com/v1`
+- OpenRouter: `https://openrouter.ai/api/v1`
+- Local LLM gateway: `http://localhost:11434/v1`
+
+See: `docs-terminai/multi-llm-support.md`
+
+```markdown
+Use `/llm reset` to switch when inside. Note right now hot-swap is not fully
+live. Please restart (Ctrl-C and npm run start or terminai) to apply changes.
+```
+
+---
+
+## Safety model (high level)
+
+TerminAI routes execution through governed tools and a deterministic approval
+ladder:
+
+- **Level A**: safe/reversible actions (no approval)
+- **Level B**: mutating actions (explicit approval)
+- **Level C**: destructive or high-risk actions (explicit approval + PIN)
+
+Audit logs are written to `~/.terminai/logs/audit/` (JSONL). Runtime/session
+logs live in `~/.terminai/logs/`.
+
+> Zero telemetry by design. No opt-in, no opt-out: just local logs you can
+> inspect. Nothing leaves your system, except for the LLM provider you choose to
+> use.
+
+## Documentation
+
+Start here:
+
+- `docs-terminai/quickstart.md`
+- `docs-terminai/configuration.md`
+- `docs-terminai/troubleshooting.md`
+- `docs-terminai/voice.md`
+- `docs-terminai/multi-llm-support.md`
+
+Contributor and security references:
+
+- `AGENTS.md`
+- `CONTRIBUTING.md`
+- `SECURITY.md`
+
+---
+
+<details>
+<summary><strong>Architecture (monorepo)</strong></summary>
+
+```text
+packages/
+├── core/           # Engine: tools, policy, routing, logging/telemetry (opt-in)
+├── cli/            # Terminal UI (Ink/React)
+├── desktop/        # Tauri app + PTY bridge (preview)
+├── a2a-server/     # Agent-to-Agent control plane (preview)
+├── termai/         # `terminai` launcher
+├── cloud-relay/    # Self-hosted relay server (optional/preview; not provided as a service)
+```
+
+</details>
+
+<details>
+<summary><strong>Development</strong></summary>
+
+Prereqs:
+
+- Node.js 20+
+- Rust (latest stable) for Desktop builds
+- Platform-specific build tools (see below)
+
+**First-time setup** (auto-installs dependencies):
+
+```bash
+npm ci
+npm run setup:dev
+```
+
+This detects your OS and installs the required build tools:
+
+- **Windows**: Visual Studio Build Tools (C++ workload), WebView2
+- **Linux**: build-essential, webkit2gtk, libappindicator, librsvg
+- **macOS**: Xcode Command Line Tools
+
+Build and run the CLI from source:
+
+```bash
+npm run build
+npm start
+```
+
+Desktop dev:
+
+```bash
+npm run desktop:dev
+# Or: cd packages/desktop && npm run tauri dev
+```
+
+</details>
+
+---
+
+## Why TerminAI vs “chat-first” computer assistants?
+
+| Capability            | Chat-first assistants / UI shells   | TerminAI (governed operator runtime)                                                   |
+| --------------------- | ----------------------------------- | -------------------------------------------------------------------------------------- |
+| Real terminal control | Often best-effort command execution | **True PTY** (interactive sudo/ssh/TTY flows)                                          |
+| Safety model          | “Be careful” prompts                | **Policy + A/B/C approvals** for risky actions                                         |
+| Traceability          | Partial transcripts                 | **Local JSONL audit logs** of what ran and why                                         |
+| Provider choice       | Frequently tied to one model/vendor | **Model-agnostic** (Gemini / ChatGPT native Oauth, OpenAI-compatible + local gateways) |
+| Platforms             | Varies                              | **Windows + Linux + macOS** (CLI-first)                                                |
+| Goal                  | Assist with tasks                   | **Mutate system state safely** (review → approve → execute → verify)                   |
+| Privacy               | Varies.                             | Zero telemetry. Works great with local-hosted models                                   |
+| Price                 | $100                                | Free. Works great with free models in OpenRouter (e.g., GPT-OSS)                       |
+
+## Lineage
+
+TerminAI is the open-source evolution of Google's Gemini CLI:
+
+- https://github.com/google-gemini/gemini-cli (Upstream)
+
+---
+
+## License and trademarks
+
+- License: Apache-2.0 (see `LICENSE`)
+- Trademark: see `TRADEMARK.md`