open-terminal-agent 0.1.0__tar.gz

open_terminal_agent-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2026 jeean404
+
+   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.

open_terminal_agent-0.1.0/MANIFEST.in

@@ -0,0 +1,23 @@
+# sdist 清单：显式声明非代码资源的去留，防 setuptools 行为漂移。
+# wheel 侧由 pyproject 的 [tool.setuptools.package-data] 覆盖；此处保 sdist
+# 与 wheel 同源，并把 React 源码工程（frontend/ui/，含 node_modules）挡在包外
+# —— 其构建产物已提交在 frontend/static/ui/，运行时只 serve 产物。
+
+include README.md
+include LICENSE
+include pyproject.toml
+include ot.spec
+recursive-include packaging *.py
+
+# Web 前端运行时资源（index.html + static/（含 static/ui/ 产物）+ vendor/）
+include src/openterminal/web/frontend/index.html
+recursive-include src/openterminal/web/frontend/static *.css *.js
+recursive-include src/openterminal/web/frontend/vendor *.css *.js
+
+# 内置 Agent Skills
+recursive-include src/openterminal/skills *.md
+
+# 明确排除前端源码工程与构建缓存
+prune src/openterminal/web/frontend/ui
+global-exclude *.py[cod]
+global-exclude .DS_Store

open_terminal_agent-0.1.0/PKG-INFO

@@ -0,0 +1,321 @@
+Metadata-Version: 2.4
+Name: open-terminal-agent
+Version: 0.1.0
+Summary: Natural-language terminal agent over local or SSH shells
+License-Expression: Apache-2.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Shells
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: deepagents>=0.7.15
+Requires-Dist: langchain-anthropic>=1.7.2
+Requires-Dist: langchain-openai>=1.0
+Requires-Dist: asyncssh>=2.24.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: prompt_toolkit>=3.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: socksio>=1.0.0
+Requires-Dist: pywinpty>=2.2; sys_platform == "win32"
+Requires-Dist: keyring>=25.0.0
+Requires-Dist: fastapi>=0.110
+Requires-Dist: uvicorn>=0.27
+Requires-Dist: tiktoken>=0.7
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.24; extra == "dev"
+Requires-Dist: httpx>=0.27; extra == "dev"
+Dynamic: license-file
+
+# OpenTerminal
+
+[![CI](https://github.com/jeean404/OpenTerminal/actions/workflows/ci.yml/badge.svg)](https://github.com/jeean404/OpenTerminal/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[中文文档](README.zh-CN.md)
+
+**Tell your terminal what you want in plain language — it does the work.**
+
+OpenTerminal lives in your terminal (and your browser). Type a normal sentence
+like *"check which files are eating the most space"* and it figures out the
+right commands, runs them, and sums up the results. Plain commands still work
+exactly as you'd expect. It can hop to your remote servers over SSH too, so
+you can leave Xshell behind.
+
+<div align="center">
+  <img src="docs/images/demo-web.gif" width="860" alt="OpenTerminal demo: natural language task → analysis → approval → execution → summary">
+</div>
+
+Here's what happens in the demo above:
+
+1. You type **"在 /tmp 下新建一个名叫 ot-demo 的文件夹"** (plain language);
+2. The AI first shows its **analysis** — what it's about to do and why;
+3. Creating a folder changes the system, so an **approval panel** pops up — nothing runs without your OK;
+4. You hit **执行 (Execute)** — the command runs with its output shown verbatim;
+5. A **summary** card wraps up what was done.
+
+> ⚠️ **Beta**: OpenTerminal runs real commands on real machines — including
+> production servers. Every state-changing command needs your approval (see
+> [Security model](#security-model)), but please still read what you're approving.
+
+## Why you might like it
+
+- **Say it, don't grep it.** Natural language in, correct commands out — with
+  the analysis shown before anything runs.
+- **It knows your systems.** Ubuntu→apt, CentOS 7→yum, Rocky/Fedora→dnf,
+  Alpine→apk, macOS→brew. Same request, right dialect for each machine.
+- **It doesn't get sloppy.** Read-only commands run by themselves; anything
+  destructive waits for your approval; catastrophic commands (`rm -rf /`,
+  fork bombs, …) are refused outright. Failed attempts get a bounded
+  self-correction budget (10 turns), not infinite retry loops.
+- **Your shell stays yours.** Persistent session (`cd`, exports, venv all
+  survive), and full-screen programs like vim/top/tmux take over the
+  terminal natively — the pipeline is a true PTY passthrough, so
+  they just work inline.
+- **Two ways in.** A single-pipeline terminal (`ot`), or `ot web` — a
+  browser UI with a server sidebar and multi-tab terminals, sharing the
+  same core.
+
+## Installation
+
+Pick whichever suits you — a pre-built binary (no Python needed), a package
+manager, or from source.
+
+### Pre-built binaries (macOS & Windows)
+
+Download from [Releases](https://github.com/jeean404/OpenTerminal/releases),
+unpack, and put the `ot` executable on your `PATH`. Replace `vX.Y.Z` with the
+latest tag:
+
+| Platform | Asset |
+|---|---|
+| macOS (Apple Silicon) | `ot-vX.Y.Z-macos-arm64.tar.gz` |
+| macOS (Intel) | `ot-vX.Y.Z-macos-x86_64.tar.gz` |
+| Windows (x64) | `ot-vX.Y.Z-windows-x64.zip` |
+
+```sh
+# macOS
+tar -xzf ot-vX.Y.Z-macos-arm64.tar.gz
+sudo mv ot/ot /usr/local/bin/ot        # or any directory on your PATH
+```
+
+On Windows, unzip and add the `ot` folder to your `PATH`, then run `ot.exe`.
+
+> **Intel Macs**: GitHub retired its Intel macOS runners, so the x86_64 binary
+> is built and attached manually per release. If a release is missing it,
+> install from PyPI with `pipx install open-terminal-agent` (see below), which works
+> on both architectures.
+
+> **macOS Gatekeeper** — the binaries are ad-hoc signed (not notarized), so
+> the first launch may be blocked with *“ot cannot be opened.”* Clear the
+> quarantine flag once with `xattr -cr "$(command -v ot)"`, or right-click →
+> Open. The first run also triggers a one-time OS security scan; later runs
+> start in under a second (the AI stack is loaded lazily on the first AI
+> task, which takes a few extra seconds once).
+
+> **Windows SmartScreen** — you may see *“Windows protected your PC”* (the
+> binary is unsigned). Click **More info → Run anyway**.
+
+### pipx / uv (from PyPI)
+
+The Python package is `open-terminal-agent` (it installs the `ot` command):
+
+```sh
+pipx install open-terminal-agent
+# or
+uv tool install open-terminal-agent
+```
+
+Requires Python 3.11+.
+
+### From source (development)
+
+```sh
+conda create -n openterminal python=3.12 -y   # or any virtualenv
+conda activate openterminal
+pip install -e .
+```
+
+Then set up your model gateway (see below) and run it:
+
+```sh
+mkdir -p ~/.openterminal && cp .env.example ~/.openterminal/.env
+# edit ~/.openterminal/.env — point it at a model gateway
+```
+
+## Quick start
+
+```sh
+ot          # terminal — local shell + main menu (connect / manage hosts)
+ot web      # browser terminal — server sidebar + multi-tab UI (default http://127.0.0.1:8080)
+```
+
+More ways to connect:
+
+```sh
+ot connect prod-web      # a host from ~/.ssh/config
+ot ssh deploy@host:2222  # or user@host:port directly
+```
+
+## Model gateway configuration
+
+OpenTerminal talks to any Anthropic-compatible gateway. On startup it loads
+`.env` from the current directory, then `~/.openterminal/.env`, then
+`~/.openterminal/config.toml`. **None of these are required** — defaults:
+
+- Protocol: `anthropic` (default) or `openai` (OpenAI-compatible protocol)
+- Gateway: `http://127.0.0.1:15721` (Anthropic-compatible protocol; the `openai`
+  provider defaults to the official endpoint)
+- Model: `claude-sonnet-4-6` (`gpt-5` under the `openai` provider)
+- API key: from the `ANTHROPIC_API_KEY` environment variable
+  (`OPENAI_API_KEY` under the `openai` provider)
+
+Optional `~/.openterminal/config.toml` (every field may be omitted):
+
+```toml
+[model]
+provider = "anthropic"       # anthropic | openai (OpenAI-compatible protocol)
+base_url = "http://127.0.0.1:15721"
+model = "claude-sonnet-4-6"
+api_key_env = "ANTHROPIC_API_KEY"
+
+# OpenAI-compatible protocol example (any OpenAI-compatible gateway works;
+# the defaults of the four fields above switch to an openai set with the
+# provider — explicit fields always win):
+# provider = "openai"
+# base_url = "https://api.openai.com/v1"
+# model = "gpt-5"
+# api_key_env = "OPENAI_API_KEY"
+
+[shell]
+timeout_default = 120        # per-command wait budget (seconds)
+max_output_bytes = 102400    # per-command output truncation
+max_tool_turns = 10          # agent tool-call turn budget
+
+[policy]
+mode = "tiered"              # tiered | approve-all | deny-all
+# auto_extra / approve_extra / deny_extra append exact-match custom rules
+
+[target.prod-web]
+mode = "ssh"
+host = "prod-web.example.com"
+```
+
+Config directory can be moved with `OPENTERMINAL_HOME` (the test suite uses
+this for isolation). Transcripts go to `~/.openterminal/sessions/`; host
+profiles are cached in `~/.openterminal/hosts.toml`.
+
+## Day-to-day use
+
+**In the terminal** — just type. A normal sentence becomes a task; a plain
+command runs in your real shell. `!` forces a command, `?` forces a task.
+`/target` switch host, `/system` override the detected dialect, `/clear`
+new task, `/model` show model, `/exit` quit. Ctrl+C interrupts a running
+task and returns you to the prompt.
+
+**In the browser** (`ot web`) — pick a server from the sidebar (local or
+direct SSH), open as many tabs as you like, and work in the Agent view or
+plain Shell view. Passwords and host keys are entered in browser dialogs;
+remembered passwords go through the OS credential store, so reconnecting is
+password-free.
+
+**LAN access**: `ot web --host 0.0.0.0 --token <TOKEN>` — a token is
+mandatory for non-loopback binds. Config: `[web] host/port/token` in
+`config.toml`.
+
+## Security model
+
+The rule of thumb: **looking is free; changing things needs your OK; disasters
+are refused.**
+
+Three tiers (`src/openterminal/policy.py`):
+
+- **auto** — read-only stuff runs on its own: `ls`/`cat`/`df`/`ps`,
+  `git status/log`, `find` without `-exec/-delete`, …
+- **approve** — anything that modifies the system: deleting files, writing
+  files, installing packages, `systemctl`, `sudo`, network config, plus
+  anything the static rules can't confidently judge. A panel opens:
+  `y` execute / `e` edit / `n` reject / `a` allow for this session (in the
+  web UI it's a button, with a second confirm for high-risk commands).
+- **deny** — the catastrophic stuff is refused and the reason is fed back to
+  the model so it changes course: `rm -rf /`, mkfs, `dd` to block devices,
+  fork bombs, shutdown, redirects to /dev devices, …
+
+Rejected and failed commands aren't retried verbatim: the agent is prompted
+to retry a failure at most once and never re-skin a rejected command, and
+tool-call turns are budget-bounded.
+
+## Architecture
+
+<div align="center">
+  <img src="docs/images/architecture.svg" width="860" alt="OpenTerminal architecture">
+</div>
+
+Full docs: [Architecture](docs/architecture.md) · [Design notes](docs/design.md) ·
+[Flow diagrams](docs/flows.md)
+
+Three layers: the natural-language front end (terminal or web), a
+deepagents (LangGraph) agent, and persistent shell sessions. Natural
+language goes straight to the agent for multi-turn tool use; command
+execution is a sub-capability of the agent, over the same session. The
+tiered policy is enforced as agent middleware, so the approval gate can't
+be bypassed by prompt content.
+
+Display is a **single pipeline**: PTY bytes go straight to the terminal,
+shell-integration hooks keep the books via in-band OSC markers (history /
+exit codes / AI context), and agent tool commands are injected into the
+same PTY via `__ot_exec__`, so their output lands in place. A per-session
+lock keeps commands strictly serial — one PTY is one interactive shell, so
+concurrent agent `execute` calls queue up. BEGIN/END sentinel slicing
+(`shell_session.py`) remains only for non-display paths such as headless
+`ot exec` and capability probes.
+
+There is **no model-level long-term memory** — the agent's checkpointer is
+in-memory and cleared on restart. What persists is factual state:
+
+| Store | Location | Contents |
+|---|---|---|
+| Config | `~/.openterminal/config.toml` | gateway / shell budgets / policy / targets |
+| Connections | `~/.openterminal/connections.db` | remembered connections |
+| Command history | `~/.openterminal/history.db` | per-target history, replayed into the shell on reconnect |
+| Passwords | OS credential store (keyring) | never written to plaintext files |
+| Host profiles | `~/.openterminal/hosts.toml` | per-host system profile cache |
+| Transcripts | `~/.openterminal/sessions/<date>/` | JSONL of inputs/commands/approvals/summaries |
+| Host keys | `~/.ssh/known_hosts` | written after TOFU confirmation |
+
+## Testing
+
+```sh
+pytest -q                      # Python suite (platform-gated tests auto-skip)
+node --test tests/js/*.test.cjs                        # static frontend
+cd src/openterminal/web/frontend/ui && npm ci && npm test  # React island
+```
+
+Real-sshd tests are opt-in:
+
+```sh
+OT_TEST_SSH=1 OT_TEST_SSH_HOST=127.0.0.1 OT_TEST_SSH_PORT=2222 pytest -m ssh
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). Issues and pull requests are welcome.
+
+## Acknowledgments
+
+- [deepagents](https://github.com/langchain-ai/deepagents) & LangGraph — agent runtime
+- [xterm.js](https://xtermjs.org/) — browser terminal (vendored in `web/frontend/vendor/`)
+- [asyncssh](https://github.com/ronf/asyncssh) — SSH client
+
+## License
+
+[Apache License 2.0](LICENSE)