coterm 0.1.0__tar.gz

coterm-0.1.0/LICENSE

@@ -0,0 +1,18 @@
+Coterm CLI
+Copyright (C) 2026 Coterm
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+The canonical GNU AGPLv3 license text is available from the GNU Project:
+https://www.gnu.org/licenses/agpl-3.0.txt

coterm-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+include LICENSE

coterm-0.1.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: coterm
+Version: 0.1.0
+Summary: Coterm CLI runtime
+Author: Coterm
+License-Expression: AGPL-3.0-or-later
+Project-URL: Homepage, https://github.com/Heipiao/coterm
+Project-URL: Repository, https://github.com/Heipiao/coterm
+Project-URL: Issues, https://github.com/Heipiao/coterm/issues
+Keywords: coterm,cli,agent,terminal,remote
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development
+Classifier: Topic :: Terminals
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: websockets>=12.0
+Requires-Dist: claude-agent-sdk>=0.1.49
+Requires-Dist: qrcode>=7.4.2
+Dynamic: license-file
+
+# Coterm CLI
+
+Coterm CLI is the local runtime for Coterm. It creates a session on a Coterm Hub, prints a pairing QR code, and runs the agent in your local terminal environment.
+
+This package is designed to ship as an independent product:
+
+- publish the source on GitHub
+- distribute the CLI on PyPI with `pip install coterm`
+- let users override the Hub with environment variables while keeping a built-in default
+
+Source repository:
+
+- `https://github.com/Heipiao/coterm`
+
+## License
+
+This project is licensed under the GNU Affero General Public License v3.0 or later.
+
+If you distribute a modified version of Coterm CLI, you must provide the corresponding source code under the AGPL as well.
+
+AGPL is stricter than GPL for server software: if someone modifies Coterm CLI and lets users interact with that modified version over a network, they must also offer the corresponding source code for that running version.
+
+## Requirements
+
+- Python 3.10 or newer
+- A reachable Coterm Hub
+- Claude installed and available on `PATH` for the current alpha implementation
+
+## Hub Configuration
+
+Coterm CLI has a built-in default Hub:
+
+```text
+http://127.0.0.1:18083
+```
+
+You can override it with environment variables:
+
+```bash
+export COTERM_HUB=http://your-hub.example.com
+```
+
+Coterm CLI also accepts `COTERM_HUB_BASE_URL`.
+
+Hub resolution order is:
+
+1. `--hub`
+2. `COTERM_HUB`
+3. `COTERM_HUB_BASE_URL`
+4. saved config in `~/.coterm/config.json`
+5. built-in default `http://127.0.0.1:18083`
+
+## Install
+
+Install from a published package:
+
+```bash
+pip install coterm
+```
+
+Install from a cloned repository:
+
+```bash
+cd coterm/cli
+pip install .
+```
+
+## Quick Start
+
+Check prerequisites:
+
+```bash
+coterm doctor
+```
+
+Point the CLI at your Hub if you are not using the default:
+
+```bash
+export COTERM_HUB=http://your-hub.example.com
+```
+
+Save Hub credentials if your Hub requires them:
+
+```bash
+coterm auth login --hub http://127.0.0.1:18083
+```
+
+Start a session:
+
+```bash
+coterm
+```
+
+This will:
+
+1. Create a session on the configured Hub
+2. Create a pairing token
+3. Print a QR code and pairing code
+4. Start the local agent runtime
+
+On the mobile side, the user scans the QR code or enters the pairing code to bind the iPhone to that session.
+
+## Commands
+
+```bash
+coterm
+coterm doctor
+coterm version
+coterm auth status
+coterm auth login --hub http://127.0.0.1:18083
+coterm hub status
+```
+
+## Configuration
+
+Coterm CLI reads configuration from CLI flags, environment variables, and `~/.coterm/config.json`.
+
+Important environment variables:
+
+- `COTERM_HUB` or `COTERM_HUB_BASE_URL`: Hub base URL
+- `COTERM_AUTH_TOKEN`: Hub auth token
+- `COTERM_DEVICE_ID`: Override the generated local device id
+- `COTERM_HOME`: Override config directory, default `~/.coterm`
+- `COTERM_CLAUDE_BIN`: Path to the `claude` executable
+- `COTERM_WORKING_DIR`: Default working directory
+
+Resolution order for Hub configuration is:
+
+1. CLI argument
+2. Environment variable
+3. Saved config
+4. Built-in default `http://127.0.0.1:18083`
+
+## Product Notes
+
+This package is designed to be independently installable. However, today it still depends on external runtime prerequisites:
+
+- A Hub must already exist or be separately installable
+- Claude must be installed separately
+- Authentication setup depends on your Hub deployment model
+
+For production distribution, treat `coterm-cli` and `coterm-hub` as separate deliverables unless you intentionally publish both.
+
+At the moment:
+
+- `coterm` is the user-facing runtime package
+- `coterm-hub` should be installed separately if you want local Hub management
+- `coterm hub start` should only be documented as supported when `coterm-hub` is actually installed

coterm-0.1.0/README.md

@@ -0,0 +1,148 @@
+# Coterm CLI
+
+Coterm CLI is the local runtime for Coterm. It creates a session on a Coterm Hub, prints a pairing QR code, and runs the agent in your local terminal environment.
+
+This package is designed to ship as an independent product:
+
+- publish the source on GitHub
+- distribute the CLI on PyPI with `pip install coterm`
+- let users override the Hub with environment variables while keeping a built-in default
+
+Source repository:
+
+- `https://github.com/Heipiao/coterm`
+
+## License
+
+This project is licensed under the GNU Affero General Public License v3.0 or later.
+
+If you distribute a modified version of Coterm CLI, you must provide the corresponding source code under the AGPL as well.
+
+AGPL is stricter than GPL for server software: if someone modifies Coterm CLI and lets users interact with that modified version over a network, they must also offer the corresponding source code for that running version.
+
+## Requirements
+
+- Python 3.10 or newer
+- A reachable Coterm Hub
+- Claude installed and available on `PATH` for the current alpha implementation
+
+## Hub Configuration
+
+Coterm CLI has a built-in default Hub:
+
+```text
+http://127.0.0.1:18083
+```
+
+You can override it with environment variables:
+
+```bash
+export COTERM_HUB=http://your-hub.example.com
+```
+
+Coterm CLI also accepts `COTERM_HUB_BASE_URL`.
+
+Hub resolution order is:
+
+1. `--hub`
+2. `COTERM_HUB`
+3. `COTERM_HUB_BASE_URL`
+4. saved config in `~/.coterm/config.json`
+5. built-in default `http://127.0.0.1:18083`
+
+## Install
+
+Install from a published package:
+
+```bash
+pip install coterm
+```
+
+Install from a cloned repository:
+
+```bash
+cd coterm/cli
+pip install .
+```
+
+## Quick Start
+
+Check prerequisites:
+
+```bash
+coterm doctor
+```
+
+Point the CLI at your Hub if you are not using the default:
+
+```bash
+export COTERM_HUB=http://your-hub.example.com
+```
+
+Save Hub credentials if your Hub requires them:
+
+```bash
+coterm auth login --hub http://127.0.0.1:18083
+```
+
+Start a session:
+
+```bash
+coterm
+```
+
+This will:
+
+1. Create a session on the configured Hub
+2. Create a pairing token
+3. Print a QR code and pairing code
+4. Start the local agent runtime
+
+On the mobile side, the user scans the QR code or enters the pairing code to bind the iPhone to that session.
+
+## Commands
+
+```bash
+coterm
+coterm doctor
+coterm version
+coterm auth status
+coterm auth login --hub http://127.0.0.1:18083
+coterm hub status
+```
+
+## Configuration
+
+Coterm CLI reads configuration from CLI flags, environment variables, and `~/.coterm/config.json`.
+
+Important environment variables:
+
+- `COTERM_HUB` or `COTERM_HUB_BASE_URL`: Hub base URL
+- `COTERM_AUTH_TOKEN`: Hub auth token
+- `COTERM_DEVICE_ID`: Override the generated local device id
+- `COTERM_HOME`: Override config directory, default `~/.coterm`
+- `COTERM_CLAUDE_BIN`: Path to the `claude` executable
+- `COTERM_WORKING_DIR`: Default working directory
+
+Resolution order for Hub configuration is:
+
+1. CLI argument
+2. Environment variable
+3. Saved config
+4. Built-in default `http://127.0.0.1:18083`
+
+## Product Notes
+
+This package is designed to be independently installable. However, today it still depends on external runtime prerequisites:
+
+- A Hub must already exist or be separately installable
+- Claude must be installed separately
+- Authentication setup depends on your Hub deployment model
+
+For production distribution, treat `coterm-cli` and `coterm-hub` as separate deliverables unless you intentionally publish both.
+
+At the moment:
+
+- `coterm` is the user-facing runtime package
+- `coterm-hub` should be installed separately if you want local Hub management
+- `coterm hub start` should only be documented as supported when `coterm-hub` is actually installed

coterm-0.1.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "coterm"
+description = "Coterm CLI runtime"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "AGPL-3.0-or-later"
+license-files = ["LICENSE"]
+authors = [
+    {name = "Coterm"},
+]
+keywords = ["coterm", "cli", "agent", "terminal", "remote"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development",
+    "Topic :: Terminals",
+]
+dynamic = ["version"]
+dependencies = [
+    "websockets>=12.0",
+    "claude-agent-sdk>=0.1.49",
+    "qrcode>=7.4.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/Heipiao/coterm"
+Repository = "https://github.com/Heipiao/coterm"
+Issues = "https://github.com/Heipiao/coterm/issues"
+
+[project.scripts]
+coterm = "coterm_cli.main:main"
+coterm-cli = "coterm_cli.main:main"
+
+[tool.setuptools.package-dir]
+"" = "src"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+version = {attr = "coterm_cli.__version__"}

coterm-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

coterm-0.1.0/src/coterm.egg-info/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: coterm
+Version: 0.1.0
+Summary: Coterm CLI runtime
+Author: Coterm
+License-Expression: AGPL-3.0-or-later
+Project-URL: Homepage, https://github.com/Heipiao/coterm
+Project-URL: Repository, https://github.com/Heipiao/coterm
+Project-URL: Issues, https://github.com/Heipiao/coterm/issues
+Keywords: coterm,cli,agent,terminal,remote
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development
+Classifier: Topic :: Terminals
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: websockets>=12.0
+Requires-Dist: claude-agent-sdk>=0.1.49
+Requires-Dist: qrcode>=7.4.2
+Dynamic: license-file
+
+# Coterm CLI
+
+Coterm CLI is the local runtime for Coterm. It creates a session on a Coterm Hub, prints a pairing QR code, and runs the agent in your local terminal environment.
+
+This package is designed to ship as an independent product:
+
+- publish the source on GitHub
+- distribute the CLI on PyPI with `pip install coterm`
+- let users override the Hub with environment variables while keeping a built-in default
+
+Source repository:
+
+- `https://github.com/Heipiao/coterm`
+
+## License
+
+This project is licensed under the GNU Affero General Public License v3.0 or later.
+
+If you distribute a modified version of Coterm CLI, you must provide the corresponding source code under the AGPL as well.
+
+AGPL is stricter than GPL for server software: if someone modifies Coterm CLI and lets users interact with that modified version over a network, they must also offer the corresponding source code for that running version.
+
+## Requirements
+
+- Python 3.10 or newer
+- A reachable Coterm Hub
+- Claude installed and available on `PATH` for the current alpha implementation
+
+## Hub Configuration
+
+Coterm CLI has a built-in default Hub:
+
+```text
+http://127.0.0.1:18083
+```
+
+You can override it with environment variables:
+
+```bash
+export COTERM_HUB=http://your-hub.example.com
+```
+
+Coterm CLI also accepts `COTERM_HUB_BASE_URL`.
+
+Hub resolution order is:
+
+1. `--hub`
+2. `COTERM_HUB`
+3. `COTERM_HUB_BASE_URL`
+4. saved config in `~/.coterm/config.json`
+5. built-in default `http://127.0.0.1:18083`
+
+## Install
+
+Install from a published package:
+
+```bash
+pip install coterm
+```
+
+Install from a cloned repository:
+
+```bash
+cd coterm/cli
+pip install .
+```
+
+## Quick Start
+
+Check prerequisites:
+
+```bash
+coterm doctor
+```
+
+Point the CLI at your Hub if you are not using the default:
+
+```bash
+export COTERM_HUB=http://your-hub.example.com
+```
+
+Save Hub credentials if your Hub requires them:
+
+```bash
+coterm auth login --hub http://127.0.0.1:18083
+```
+
+Start a session:
+
+```bash
+coterm
+```
+
+This will:
+
+1. Create a session on the configured Hub
+2. Create a pairing token
+3. Print a QR code and pairing code
+4. Start the local agent runtime
+
+On the mobile side, the user scans the QR code or enters the pairing code to bind the iPhone to that session.
+
+## Commands
+
+```bash
+coterm
+coterm doctor
+coterm version
+coterm auth status
+coterm auth login --hub http://127.0.0.1:18083
+coterm hub status
+```
+
+## Configuration
+
+Coterm CLI reads configuration from CLI flags, environment variables, and `~/.coterm/config.json`.
+
+Important environment variables:
+
+- `COTERM_HUB` or `COTERM_HUB_BASE_URL`: Hub base URL
+- `COTERM_AUTH_TOKEN`: Hub auth token
+- `COTERM_DEVICE_ID`: Override the generated local device id
+- `COTERM_HOME`: Override config directory, default `~/.coterm`
+- `COTERM_CLAUDE_BIN`: Path to the `claude` executable
+- `COTERM_WORKING_DIR`: Default working directory
+
+Resolution order for Hub configuration is:
+
+1. CLI argument
+2. Environment variable
+3. Saved config
+4. Built-in default `http://127.0.0.1:18083`
+
+## Product Notes
+
+This package is designed to be independently installable. However, today it still depends on external runtime prerequisites:
+
+- A Hub must already exist or be separately installable
+- Claude must be installed separately
+- Authentication setup depends on your Hub deployment model
+
+For production distribution, treat `coterm-cli` and `coterm-hub` as separate deliverables unless you intentionally publish both.
+
+At the moment:
+
+- `coterm` is the user-facing runtime package
+- `coterm-hub` should be installed separately if you want local Hub management
+- `coterm hub start` should only be documented as supported when `coterm-hub` is actually installed

coterm-0.1.0/src/coterm.egg-info/SOURCES.txt

@@ -0,0 +1,25 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+src/coterm.egg-info/PKG-INFO
+src/coterm.egg-info/SOURCES.txt
+src/coterm.egg-info/dependency_links.txt
+src/coterm.egg-info/entry_points.txt
+src/coterm.egg-info/requires.txt
+src/coterm.egg-info/top_level.txt
+src/coterm_cli/__init__.py
+src/coterm_cli/__main__.py
+src/coterm_cli/adapter.py
+src/coterm_cli/bootstrap.py
+src/coterm_cli/claude_adapter.py
+src/coterm_cli/commands.py
+src/coterm_cli/config.py
+src/coterm_cli/hub_client.py
+src/coterm_cli/main.py
+src/coterm_cli/models.py
+src/coterm_cli/process.py
+src/coterm_cli/qr.py
+src/coterm_cli/runtime.py
+src/coterm_cli/session.py
+src/coterm_cli/user_config.py

coterm-0.1.0/src/coterm.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

coterm-0.1.0/src/coterm.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+coterm = coterm_cli.main:main
+coterm-cli = coterm_cli.main:main

coterm-0.1.0/src/coterm.egg-info/requires.txt

@@ -0,0 +1,3 @@
+websockets>=12.0
+claude-agent-sdk>=0.1.49
+qrcode>=7.4.2

coterm-0.1.0/src/coterm.egg-info/top_level.txt

@@ -0,0 +1 @@
+coterm_cli

coterm-0.1.0/src/coterm_cli/__init__.py

@@ -0,0 +1,3 @@
+"""Coterm CLI runtime package."""
+
+__version__ = "0.1.0"

coterm-0.1.0/src/coterm_cli/__main__.py

@@ -0,0 +1,5 @@
+from .main import main
+
+
+if __name__ == "__main__":
+    main()

coterm-0.1.0/src/coterm_cli/adapter.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from collections.abc import AsyncIterator
+
+from .models import AgentEvent, PermissionDecision
+
+
+class AgentAdapter(ABC):
+    @abstractmethod
+    async def start(self) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    async def stop(self) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    async def send_user_message(self, message_id: str, content: str) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    async def send_permission_decision(self, request_id: str, decision: PermissionDecision) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    async def cancel_current_turn(self) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    async def events(self) -> AsyncIterator[AgentEvent]:
+        raise NotImplementedError