cyclo-manager 1.0.0.dev10__tar.gz → 1.1.0.dev2__tar.gz

{cyclo_manager-1.0.0.dev10 → cyclo_manager-1.1.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cyclo-manager
-Version: 1.0.0.dev10
+Version: 1.1.0.dev2
 Summary: cyclo_manager CLI: pip-installable launcher for cyclo_manager server and UI containers. Run 'cyclo_manager up' to start Docker stack.
 License-Expression: Apache-2.0
 Requires-Python: >=3.10
@@ -18,7 +18,7 @@ Requires-Dist: ruff; extra == "dev"
 **Console commands:** `cyclo_manager` (underscore), `cyclo-manager` (hyphen)  
 **Host agent:** `cyclo_host_agent` (installed by the package, run via systemd)
 
-This package is the **pip-installable launcher** for the cyclo_manager stack on a robot host. It:
+This package is the **pip-installable launcher** for the cyclo_manager stack on a robot host. It is intended for production robots that run the pre-built Docker images. It:
 
 1. Runs **`docker compose`** against a **bundled** [`cyclo_manager_cli/docker/docker-compose.yml`](cyclo_manager_cli/docker/docker-compose.yml) to start the **API** and **web UI** containers.
 2. Installs and maintains **`cyclo_host_agent`** as a **systemd** service for host-level operations (git repo updates, `cyclo_manager` package update from the UI).
@@ -50,11 +50,12 @@ For the full monorepo (API source, UI source, dev compose), see the [repository
 
 ## Prerequisites
 
-- **Docker** with **Compose v2** (`docker compose` — the legacy `docker-compose` binary alone is not enough)
+- **Docker** with **Compose v2** (`docker compose`; the legacy `docker-compose` binary alone is not enough)
 - **Python 3.10+**
+- **systemd**: required for the managed `cyclo_host_agent.service`
 - **`sudo`** — required on normal-user hosts to install the host agent systemd unit, socket directory permissions, and sudoers rules
 - For **`cyclo_manager update`:** **`pip`** or **`pip3`** on `PATH`
-- **Root shell handling** — root is rejected when a normal login user exists. On root-only devices, the host agent is installed as root.
+- **Root shell handling** — `cyclo_manager up` rejects direct root execution when a normal login user exists. On root-only devices, the host agent is installed as root.
 - **Agent sockets** on the host under `/var/run/robotis/agent_sockets/` (robot containers and host agent). The bundled Compose file bind-mounts this tree into the API container as `/agents/`.
 
 ---
@@ -94,6 +95,8 @@ python3 -m cyclo_manager_cli.cli up
 | `cyclo_manager update --no-pull` | Same as `update`, but skip image pull (use locally cached images). |
 | `cyclo_manager --help` | Subcommand overview |
 
+The CLI also has an internal `refresh-host-agent` subcommand. It is used by the sudoers rule and should normally not be invoked by users directly.
+
 **`down` vs `update`:** `down` removes the host agent entirely. `update` only stops Docker containers, upgrades the pip package, restarts the stack, and refreshes the host agent — it does **not** call `cyclo_manager down`.
 
 ---
@@ -120,18 +123,21 @@ The pip package installs a small **FastAPI** server that listens on a **Unix dom
 |------|------|
 | Socket | `/var/run/robotis/agent_sockets/host/host_agent.sock` |
 | systemd unit | `cyclo_host_agent.service` |
-| sudoers | `/etc/sudoers.d/cyclo_manager` (`cp`, `udevadm` for container setup scripts; `refresh-host-agent` CLI subcommand for UI updates; skipped on root-only devices) |
+| sudoers | `/etc/sudoers.d/cyclo_manager` (`cp`, `udevadm` for container setup scripts; `refresh-host-agent` CLI subcommand for package-update refresh; skipped on root-only devices) |
 
 The API container reaches it at `/agents/host/host_agent.sock` (see bundled `config.yml`).
 
 **Responsibilities:**
 
-- List and update **`~/ROBOTIS-GIT/*`** git repositories (Version Management in the UI)
-- Run Cyclo Manager package updates from the UI by delegating to `cyclo_manager update`
+- List managed **ROBOTIS-GIT** git repositories in the configured workspace.
+- Check update availability from remote tags and local `package.xml` versions.
+- Update repos on allowed branches (`main`, `jazzy`) using stash or reset workflows.
+- Stop/start a repo's `docker/container.sh` helper during an update when requested by the UI.
+- Run Cyclo Manager package updates from the UI by delegating to `cyclo_manager update`.
 
 `cyclo_manager up` installs the `refresh-host-agent` CLI subcommand into sudoers. It is registered as `sys.executable -m cyclo_manager_cli.cli refresh-host-agent` with `SETENV`, so UI-triggered updates can pass the current `PYTHONPATH` to sudo and do not depend on `PATH`. The command is idempotent and refreshes the socket directory, sudoers file, systemd unit, and service state after package upgrades.
 
-Repository scanning uses `CYCLO_HOST_AGENT_WORKSPACE` when set. Otherwise it uses the service user's home directory, except root-only devices with `/data/docker`, where `/data/docker` is used automatically.
+Repository scanning and the Files UI use `CYCLO_HOST_AGENT_WORKSPACE` when set. Otherwise they use the service user's home directory, except root-only devices with `/data/docker`, where `/data/docker` is used automatically. Only repositories whose `origin` remote belongs to `ROBOTIS-GIT` are returned by the repo list/update endpoints.
 
 ---
 
@@ -211,6 +217,7 @@ So `/agents/ai_worker/s6_agent.sock` in config corresponds to the host path abov
 | Variable | Set by | Purpose |
 |----------|--------|---------|
 | **`CYCLO_MANAGER_CONFIG_FILE`** | CLI (`up`, `down`, `update`) | Absolute path to bundled `config.yml` on the host; mounted into the API container |
+| **`CYCLO_HOST_AGENT_WORKSPACE`** | User or CLI-generated systemd unit | Workspace scanned by `cyclo_host_agent` for managed git repositories and used as the Files UI/API root |
 | **`HOSTNAME`** | CLI (default: machine hostname) | Passed to API as `HOST_HOSTNAME` |
 | **`CONFIG_FILE`** | Compose (`/app/config.yml`) | Path inside the API container |
 | **`ROS_DOMAIN_ID`** | **Not** set by CLI | Set inside robot containers (e.g. `~/.bashrc`) so DDS matches your fleet |
@@ -252,7 +259,7 @@ Python dependencies declared in [`pyproject.toml`](pyproject.toml):
 |---------|---------|
 | **fastapi** | `cyclo_host_agent` HTTP API |
 | **uvicorn** | `cyclo_host_agent` server |
-| **psutil** | Host agent / system utilities |
+| **psutil** | Declared package dependency for host/system utility support |
 
 The **`cyclo_manager`** CLI itself uses only the Python standard library plus **`subprocess`** calls to **`docker compose`**, **`pip`**, **`systemctl`**, and **`sudo`**.
 

{cyclo_manager-1.0.0.dev10 → cyclo_manager-1.1.0.dev2}/README.md

@@ -4,7 +4,7 @@
 **Console commands:** `cyclo_manager` (underscore), `cyclo-manager` (hyphen)  
 **Host agent:** `cyclo_host_agent` (installed by the package, run via systemd)
 
-This package is the **pip-installable launcher** for the cyclo_manager stack on a robot host. It:
+This package is the **pip-installable launcher** for the cyclo_manager stack on a robot host. It is intended for production robots that run the pre-built Docker images. It:
 
 1. Runs **`docker compose`** against a **bundled** [`cyclo_manager_cli/docker/docker-compose.yml`](cyclo_manager_cli/docker/docker-compose.yml) to start the **API** and **web UI** containers.
 2. Installs and maintains **`cyclo_host_agent`** as a **systemd** service for host-level operations (git repo updates, `cyclo_manager` package update from the UI).
@@ -36,11 +36,12 @@ For the full monorepo (API source, UI source, dev compose), see the [repository
 
 ## Prerequisites
 
-- **Docker** with **Compose v2** (`docker compose` — the legacy `docker-compose` binary alone is not enough)
+- **Docker** with **Compose v2** (`docker compose`; the legacy `docker-compose` binary alone is not enough)
 - **Python 3.10+**
+- **systemd**: required for the managed `cyclo_host_agent.service`
 - **`sudo`** — required on normal-user hosts to install the host agent systemd unit, socket directory permissions, and sudoers rules
 - For **`cyclo_manager update`:** **`pip`** or **`pip3`** on `PATH`
-- **Root shell handling** — root is rejected when a normal login user exists. On root-only devices, the host agent is installed as root.
+- **Root shell handling** — `cyclo_manager up` rejects direct root execution when a normal login user exists. On root-only devices, the host agent is installed as root.
 - **Agent sockets** on the host under `/var/run/robotis/agent_sockets/` (robot containers and host agent). The bundled Compose file bind-mounts this tree into the API container as `/agents/`.
 
 ---
@@ -80,6 +81,8 @@ python3 -m cyclo_manager_cli.cli up
 | `cyclo_manager update --no-pull` | Same as `update`, but skip image pull (use locally cached images). |
 | `cyclo_manager --help` | Subcommand overview |
 
+The CLI also has an internal `refresh-host-agent` subcommand. It is used by the sudoers rule and should normally not be invoked by users directly.
+
 **`down` vs `update`:** `down` removes the host agent entirely. `update` only stops Docker containers, upgrades the pip package, restarts the stack, and refreshes the host agent — it does **not** call `cyclo_manager down`.
 
 ---
@@ -106,18 +109,21 @@ The pip package installs a small **FastAPI** server that listens on a **Unix dom
 |------|------|
 | Socket | `/var/run/robotis/agent_sockets/host/host_agent.sock` |
 | systemd unit | `cyclo_host_agent.service` |
-| sudoers | `/etc/sudoers.d/cyclo_manager` (`cp`, `udevadm` for container setup scripts; `refresh-host-agent` CLI subcommand for UI updates; skipped on root-only devices) |
+| sudoers | `/etc/sudoers.d/cyclo_manager` (`cp`, `udevadm` for container setup scripts; `refresh-host-agent` CLI subcommand for package-update refresh; skipped on root-only devices) |
 
 The API container reaches it at `/agents/host/host_agent.sock` (see bundled `config.yml`).
 
 **Responsibilities:**
 
-- List and update **`~/ROBOTIS-GIT/*`** git repositories (Version Management in the UI)
-- Run Cyclo Manager package updates from the UI by delegating to `cyclo_manager update`
+- List managed **ROBOTIS-GIT** git repositories in the configured workspace.
+- Check update availability from remote tags and local `package.xml` versions.
+- Update repos on allowed branches (`main`, `jazzy`) using stash or reset workflows.
+- Stop/start a repo's `docker/container.sh` helper during an update when requested by the UI.
+- Run Cyclo Manager package updates from the UI by delegating to `cyclo_manager update`.
 
 `cyclo_manager up` installs the `refresh-host-agent` CLI subcommand into sudoers. It is registered as `sys.executable -m cyclo_manager_cli.cli refresh-host-agent` with `SETENV`, so UI-triggered updates can pass the current `PYTHONPATH` to sudo and do not depend on `PATH`. The command is idempotent and refreshes the socket directory, sudoers file, systemd unit, and service state after package upgrades.
 
-Repository scanning uses `CYCLO_HOST_AGENT_WORKSPACE` when set. Otherwise it uses the service user's home directory, except root-only devices with `/data/docker`, where `/data/docker` is used automatically.
+Repository scanning and the Files UI use `CYCLO_HOST_AGENT_WORKSPACE` when set. Otherwise they use the service user's home directory, except root-only devices with `/data/docker`, where `/data/docker` is used automatically. Only repositories whose `origin` remote belongs to `ROBOTIS-GIT` are returned by the repo list/update endpoints.
 
 ---
 
@@ -197,6 +203,7 @@ So `/agents/ai_worker/s6_agent.sock` in config corresponds to the host path abov
 | Variable | Set by | Purpose |
 |----------|--------|---------|
 | **`CYCLO_MANAGER_CONFIG_FILE`** | CLI (`up`, `down`, `update`) | Absolute path to bundled `config.yml` on the host; mounted into the API container |
+| **`CYCLO_HOST_AGENT_WORKSPACE`** | User or CLI-generated systemd unit | Workspace scanned by `cyclo_host_agent` for managed git repositories and used as the Files UI/API root |
 | **`HOSTNAME`** | CLI (default: machine hostname) | Passed to API as `HOST_HOSTNAME` |
 | **`CONFIG_FILE`** | Compose (`/app/config.yml`) | Path inside the API container |
 | **`ROS_DOMAIN_ID`** | **Not** set by CLI | Set inside robot containers (e.g. `~/.bashrc`) so DDS matches your fleet |
@@ -238,7 +245,7 @@ Python dependencies declared in [`pyproject.toml`](pyproject.toml):
 |---------|---------|
 | **fastapi** | `cyclo_host_agent` HTTP API |
 | **uvicorn** | `cyclo_host_agent` server |
-| **psutil** | Host agent / system utilities |
+| **psutil** | Declared package dependency for host/system utility support |
 
 The **`cyclo_manager`** CLI itself uses only the Python standard library plus **`subprocess`** calls to **`docker compose`**, **`pip`**, **`systemctl`**, and **`sudo`**.
 

{cyclo_manager-1.0.0.dev10 → cyclo_manager-1.1.0.dev2}/cyclo_host_agent/main.py

@@ -21,7 +21,7 @@
 import logging
 from pathlib import Path
 
-from cyclo_host_agent.routers import repos, update
+from cyclo_host_agent.routers import files, repos, system_stats, update
 from cyclo_manager_cli import __version__
 from fastapi import FastAPI
 import uvicorn
@@ -41,6 +41,8 @@ app = FastAPI(
 )
 
 app.include_router(repos.router)
+app.include_router(files.router)
+app.include_router(system_stats.router)
 app.include_router(update.router)
 
 

cyclo_manager-1.1.0.dev2/cyclo_host_agent/models.py

@@ -0,0 +1,242 @@
+#!/usr/bin/env python3
+#
+# Copyright 2026 ROBOTIS CO., LTD.
+#
+# 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.
+#
+# Author: Hyungyu Kim
+
+"""Pydantic models for cyclo_host_agent API."""
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class RepoInfo(BaseModel):
+    """Single git repository info."""
+
+    name: str
+    path: str
+    branch: Optional[str] = None
+    remote: Optional[str] = None
+
+
+class RepoListResponse(BaseModel):
+    """Response for GET /repos."""
+
+    repos: list[RepoInfo]
+    workspace_path: str
+
+
+class RepoUpdateStatus(BaseModel):
+    """Version update status for a single repository."""
+
+    name: str
+    branch: Optional[str] = None
+    current_version: Optional[str] = None
+    latest_version: Optional[str] = None
+    has_update: bool
+
+
+class RepoUpdatesResponse(BaseModel):
+    """Response for GET /repos/updates."""
+
+    repos: list[RepoUpdateStatus]
+    workspace_path: str
+
+
+class FileChange(BaseModel):
+    """A single entry from git status --porcelain."""
+
+    path: str
+    status: str  # e.g. M, D, ??, etc.
+
+
+class RepoStatusResponse(BaseModel):
+    """Response for GET /repos/{name}/status."""
+
+    name: str
+    changes: list[FileChange]
+    has_changes: bool
+
+
+class RepoBranchCheckResponse(BaseModel):
+    """Response for GET /repos/{name}/branch."""
+
+    name: str
+    branch: Optional[str] = None
+    allowed: bool
+
+
+class UpdateRequest(BaseModel):
+    """Request body for POST /repos/{name}/update."""
+
+    strategy: str  # 'stash' | 'reset'
+    preserve_files: list[str] = []  # files to keep when using the reset strategy
+
+
+class UpdateResponse(BaseModel):
+    """Response for POST /repos/{name}/update."""
+
+    name: str
+    success: bool
+    output: str
+    stash_conflict: bool = False
+    stash_conflict_files: list[str] = []
+
+
+class ContainerScriptResponse(BaseModel):
+    """Response for POST /repos/{name}/container/{action}."""
+
+    name: str
+    action: str
+    success: bool
+    output: str
+
+
+class ContainerStartStatusResponse(BaseModel):
+    """Current output/status for a container start operation."""
+
+    running: bool
+    output: str
+    success: bool | None = None
+    error: str = ''
+
+
+class HostSystemStatsResponse(BaseModel):
+    """Host CPU/memory/disk/uptime/temperature status."""
+
+    cpu_percent: float
+    memory_used_mb: int
+    memory_total_mb: int
+    disk_used_gb: float
+    disk_total_gb: float
+    ssd_used_gb: float | None = None
+    ssd_total_gb: float | None = None
+    ssd_mount_path: str | None = None
+    uptime_seconds: int
+    temperature_celsius: float | None = None
+
+
+class HostProcessInfo(BaseModel):
+    """Single host process CPU/memory usage sample."""
+
+    pid: int
+    user: str
+    cpu_percent: float
+    memory_percent: float
+    rss_kb: int | None = None
+    command: str
+
+
+class HostProcessesResponse(BaseModel):
+    """Host process list with aggregate resource summary."""
+
+    cpu_percent: float
+    memory_used_mb: int
+    memory_total_mb: int
+    processes: list[HostProcessInfo]
+
+
+class FileTreeEntry(BaseModel):
+    """Single file browser entry."""
+
+    name: str
+    path: str
+    type: str
+    size: int | None = None
+    modified: float | None = None
+    readonly: bool = False
+    hidden: bool = False
+    symlink: bool = False
+    git_status: str | None = None
+
+
+class FileTreeResponse(BaseModel):
+    """Response for GET /files/tree."""
+
+    root_path: str
+    path: str
+    entries: list[FileTreeEntry]
+
+
+class FileSearchResponse(BaseModel):
+    """Response for GET /files/search."""
+
+    root_path: str
+    path: str
+    query: str
+    entries: list[FileTreeEntry]
+    truncated: bool = False
+
+
+class FileReadResponse(BaseModel):
+    """Response for GET /files/read."""
+
+    path: str
+    content: str
+    size: int
+    modified: float
+    readonly: bool = False
+
+
+class FileDiffResponse(BaseModel):
+    """Response for GET /files/diff."""
+
+    path: str
+    status: str
+    original_content: str
+    current_content: str
+
+
+class FileWriteRequest(BaseModel):
+    """Request body for POST /files/write."""
+
+    path: str
+    content: str
+    expected_modified: float | None = None
+
+
+class FileCreateRequest(BaseModel):
+    """Request body for POST /files/create."""
+
+    path: str
+    type: str
+    content: str = ''
+
+
+class FileRenameRequest(BaseModel):
+    """Request body for POST /files/rename."""
+
+    path: str
+    new_name: str
+
+
+class FileUploadResponse(BaseModel):
+    """Response for POST /files/upload."""
+
+    name: str
+    path: str
+    size: int
+    overwritten: bool = False
+    success: bool
+    message: str
+
+
+class FileOperationResponse(BaseModel):
+    """Generic file operation response."""
+
+    path: str
+    success: bool
+    message: str