hiverge-cli 0.1.0__tar.gz

hiverge_cli-0.1.0/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

hiverge_cli-0.1.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: hiverge-cli
+Version: 0.1.0
+Summary: Universal Command Line Interface for Hive agent.
+Author: Hiverge Team
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=5.1
+Requires-Dist: pydantic>=1.8.2
+Requires-Dist: gitpython>=3.1.24
+Requires-Dist: python-dotenv>=0.19.2
+Requires-Dist: rich>=12.5.1
+Requires-Dist: kubernetes>=32.0.0
+Provides-Extra: test
+Provides-Extra: dev
+Requires-Dist: ruff>=0.12; extra == "dev"
+Dynamic: license-file
+
+# Hive-CLI
+
+Hive-CLI is a command-line interface for managing and deploying Hive agent and experiments on Kubernetes and other platforms.
+
+```bash
+     ███          █████   █████  ███
+    ░░░███       ░░███   ░░███  ░░░
+      ░░░███      ░███    ░███  ████  █████ █████  ██████
+        ░░░███    ░███████████ ░░███ ░░███ ░░███  ███░░███
+         ███░     ░███░░░░░███  ░███  ░███  ░███ ░███████
+       ███░       ░███    ░███  ░███  ░░███ ███  ░███░░░
+     ███░         █████   █████ █████  ░░█████   ░░██████
+    ░░░          ░░░░░   ░░░░░ ░░░░░    ░░░░░     ░░░░░░
+```
+
+## Installation
+
+### Install via pip (Not-Available Yet)
+
+```bash
+pip install hive-cli
+```
+
+### Install from source
+
+```bash
+source start.sh
+```
+
+## How to run
+
+**Note**: Hive-CLI reads the configuration from a yaml file, by default it will look for the `~/.hive/sandbox-config.yaml`. You can also specify a different configuration file using the `-f` option. Refer to the [config.yaml](./config.yaml) for examples.
+
+Below we assume that you have a `~/.hive/sandbox-config.yaml` file.
+
+### Edit the experiment
+
+`Edit` command will open the configuration file in your default editor (e.g., vim, nano, etc.) for you to modify the experiment configuration. You can also specify a different editor using the `EDITOR` environment variable, by default it will use `vim`.
+
+```bash
+hive edit config
+```
+
+### Create an experiment
+
+```bash
+hive create exp my-experiment
+```
+
+### List experiments
+
+```bash
+hive show exps
+```
+
+### Visit Dashboard
+
+```bash
+hive dashboard
+```
+
+### Delete an experiment
+
+
+```bash
+hive delete exp my-experiment
+```
+
+### More
+
+See `hive -h` for more details.
+
+## Development
+
+**Note**: Hive-CLI will read the `.env` file to load logging configurations. Refer to the `.env.example` file for examples.
+
+### Debugging
+
+Change the log level in `.env` file to `DEBUG` to see more detailed logs.

hiverge_cli-0.1.0/README.md

@@ -0,0 +1,79 @@
+# Hive-CLI
+
+Hive-CLI is a command-line interface for managing and deploying Hive agent and experiments on Kubernetes and other platforms.
+
+```bash
+     ███          █████   █████  ███
+    ░░░███       ░░███   ░░███  ░░░
+      ░░░███      ░███    ░███  ████  █████ █████  ██████
+        ░░░███    ░███████████ ░░███ ░░███ ░░███  ███░░███
+         ███░     ░███░░░░░███  ░███  ░███  ░███ ░███████
+       ███░       ░███    ░███  ░███  ░░███ ███  ░███░░░
+     ███░         █████   █████ █████  ░░█████   ░░██████
+    ░░░          ░░░░░   ░░░░░ ░░░░░    ░░░░░     ░░░░░░
+```
+
+## Installation
+
+### Install via pip (Not-Available Yet)
+
+```bash
+pip install hive-cli
+```
+
+### Install from source
+
+```bash
+source start.sh
+```
+
+## How to run
+
+**Note**: Hive-CLI reads the configuration from a yaml file, by default it will look for the `~/.hive/sandbox-config.yaml`. You can also specify a different configuration file using the `-f` option. Refer to the [config.yaml](./config.yaml) for examples.
+
+Below we assume that you have a `~/.hive/sandbox-config.yaml` file.
+
+### Edit the experiment
+
+`Edit` command will open the configuration file in your default editor (e.g., vim, nano, etc.) for you to modify the experiment configuration. You can also specify a different editor using the `EDITOR` environment variable, by default it will use `vim`.
+
+```bash
+hive edit config
+```
+
+### Create an experiment
+
+```bash
+hive create exp my-experiment
+```
+
+### List experiments
+
+```bash
+hive show exps
+```
+
+### Visit Dashboard
+
+```bash
+hive dashboard
+```
+
+### Delete an experiment
+
+
+```bash
+hive delete exp my-experiment
+```
+
+### More
+
+See `hive -h` for more details.
+
+## Development
+
+**Note**: Hive-CLI will read the `.env` file to load logging configurations. Refer to the `.env.example` file for examples.
+
+### Debugging
+
+Change the log level in `.env` file to `DEBUG` to see more detailed logs.

hiverge_cli-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "hiverge-cli"
+version = "0.1.0"
+authors = [
+  { name="Hiverge Team" },
+]
+description = "Universal Command Line Interface for Hive agent."
+readme = "README.md"
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+dependencies = [
+    "PyYAML>=5.1",
+    "pydantic>=1.8.2",
+    "gitpython>=3.1.24",
+    "python-dotenv>=0.19.2",
+    "rich>=12.5.1",
+    "kubernetes>=32.0.0",
+]
+
+[project.optional-dependencies]
+test = [
+]
+dev = [
+  "ruff>=0.12",
+]
+
+[project.scripts]
+hive = "hive_cli.main:main"
+
+[tool.ruff]
+line-length = 100
+exclude = ["libs"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+ignore = ["E501"]
+
+[tool.ruff.format]
+quote-style = "double"

hiverge_cli-0.1.0/setup.cfg

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

hiverge_cli-0.1.0/src/hive_cli/config.py

@@ -0,0 +1,129 @@
+import os
+from enum import Enum
+from typing import Optional
+
+import yaml
+from pydantic import BaseModel, Field, field_validator
+
+
+class PlatformType(str, Enum):
+    K8S = "k8s"
+    ON_PREM = "on-prem"
+
+
+class ResourceConfig(BaseModel):
+    requests: Optional[dict] = None
+    limits: Optional[dict] = None
+    accelerators: Optional[str] = None  # e.g., "a100-80gb:8"
+    shmsize: Optional[str] = None
+
+
+class EnvConfig(BaseModel):
+    name: str
+    value: str
+
+
+class SandboxConfig(BaseModel):
+    image: Optional[str] = None
+    replicas: int = 1
+    timeout: int = 60
+    resources: Optional[ResourceConfig] = None
+    envs: Optional[list[EnvConfig]] = None
+    pre_processor: Optional[str] = Field(
+        default=None,
+        description="The pre-processing script to run before the experiment. Use the `/data` directory to load/store datasets.",
+    )
+
+
+class RepoConfig(BaseModel):
+    url: str
+    branch: str = "main"
+    evaluation_script: str = "evaluator.py"
+    evolve_files_and_ranges: str
+
+
+class WanDBConfig(BaseModel):
+    enabled: bool = False
+
+
+class GCPConfig(BaseModel):
+    enabled: bool = False
+    project_id: str = Field(
+        default="runsandbox-449400",
+        description="The GCP project ID to use for the experiment.",
+    )
+    image_registry: str | None = Field(
+        default=None,
+        description="The GCP image registry to use for the experiment images. If not set, will use the default GCP registry.",
+    )
+
+
+class AWSConfig(BaseModel):
+    enabled: bool = False
+    image_registry: str | None = Field(
+        default=None,
+        description="The AWS image registry to use for the experiment images. If not set, will use the default AWS ECR registry.",
+    )
+
+
+class CloudProviderConfig(BaseModel):
+    spot: bool = False
+    gcp: Optional[GCPConfig] = None
+    aws: Optional[AWSConfig] = None
+
+
+class HiveConfig(BaseModel):
+    project_name: str = Field(
+        description="The name of the project. Must be all lowercase.",
+    )
+
+    token_path: str = Field(
+        default=os.path.expandvars("$HOME/.kube/config"),
+        description="Path to the auth token file, default to ~/.kube/config",
+    )
+
+    coordinator_config_name: str = Field(
+        default="default-coordinator-config",
+        description="The name of the coordinator config to use for the experiment. Default to 'default-coordinator-config'.",
+    )
+
+    platform: PlatformType = PlatformType.K8S
+
+    repo: RepoConfig
+    sandbox: SandboxConfig
+    wandb: Optional[WanDBConfig] = None
+
+    # cloud vendor configuration
+    cloud_provider: CloudProviderConfig
+
+    @field_validator("project_name")
+    def must_be_lowercase(cls, v):
+        if not v.islower():
+            raise ValueError("project_name must be all lowercase")
+        return v
+
+    def model_post_init(self, __context):
+        if (
+            self.cloud_provider.gcp
+            and self.cloud_provider.gcp.enabled
+            and not self.cloud_provider.gcp.image_registry
+        ):
+            self.cloud_provider.gcp.image_registry = (
+                f"gcr.io/{self.cloud_provider.gcp.project_id}/{self.project_name}"
+            )
+
+        if (
+            self.cloud_provider.aws
+            and self.cloud_provider.aws.enabled
+            and not self.cloud_provider.aws.image_registry
+        ):
+            self.cloud_provider.aws.image_registry = (
+                f"621302123805.dkr.ecr.eu-north-1.amazonaws.com/hiverge/{self.project_name}"
+            )
+
+
+def load_config(file_path: str) -> HiveConfig:
+    """Load configuration from a YAML file."""
+    with open(file_path, "r") as file:
+        config_data = yaml.safe_load(file)
+    return HiveConfig(**config_data)

hiverge_cli-0.1.0/src/hive_cli/main.py

@@ -0,0 +1,216 @@
+import argparse
+import os
+import subprocess
+
+from rich.console import Console
+from rich.text import Text
+
+from hive_cli.config import load_config
+from hive_cli.platform.k8s import K8sPlatform
+
+PLATFORMS = {
+    "k8s": K8sPlatform,
+    # "on-prem": OnPremPlatform,
+}
+
+
+def init(args):
+    print("(Unimplemented) Initializing hive...")
+
+
+def create_experiment(args):
+    BLUE = "\033[94m"
+    RESET = "\033[0m"
+
+    ascii_art = r"""
+     ███          █████   █████  ███
+    ░░░███       ░░███   ░░███  ░░░
+      ░░░███      ░███    ░███  ████  █████ █████  ██████
+        ░░░███    ░███████████ ░░███ ░░███ ░░███  ███░░███
+         ███░     ░███░░░░░███  ░███  ░███  ░███ ░███████
+       ███░       ░███    ░███  ░███  ░░███ ███  ░███░░░
+     ███░         █████   █████ █████  ░░█████   ░░██████
+    ░░░          ░░░░░   ░░░░░ ░░░░░    ░░░░░     ░░░░░░
+    """
+
+    print(f"{BLUE}{ascii_art}{RESET}")
+
+    config = load_config(args.config)
+    # Init the platform based on the config.
+    platform = PLATFORMS[config.platform.value](args.name, config.token_path)
+
+    platform.create(config=config)
+
+
+def update_experiment(args):
+    config = load_config(args.config)
+    # Init the platform based on the config.
+    platform = PLATFORMS[config.platform.value](args.name, config.token_path)
+
+    platform.update(args.name, config=config)
+
+    console = Console()
+    msg = Text(f"Experiment {args.name} updated successfully.", style="bold green")
+    console.print(msg)
+
+
+def delete_experiment(args):
+    config = load_config(args.config)
+
+    platform = PLATFORMS[args.platform](args.platform, config.token_path)
+    platform.delete(args.name)
+
+
+def show_experiment(args):
+    config = load_config(args.config)
+
+    platform = PLATFORMS[args.platform](args.platform, config.token_path)
+    platform.show_experiments(args)
+
+
+def edit(args):
+    editor = os.environ.get("EDITOR", "vim")
+    subprocess.run([editor, args.config])
+
+    console = Console()
+    msg = Text(args.config, style="bold magenta")
+    msg.append(" edited successfully.", style="bold green")
+    console.print(msg)
+
+
+def show_dashboard(args):
+    config = load_config(args.config)
+    platform = PLATFORMS[args.platform](args.platform, config.token_path)
+    platform.show_dashboard(args)
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Hive CLI")
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    # TODO:
+    # # init command
+    # parser_init = subparsers.add_parser("init", help="Initialize a repository")
+    # parser_init.set_defaults(func=init)
+
+    # create command
+    parser_create = subparsers.add_parser("create", help="Create resources")
+    create_subparsers = parser_create.add_subparsers(dest="create_target")
+
+    parser_create_exp = create_subparsers.add_parser(
+        "experiment", aliases=["exp"], help="Create a new experiment"
+    )
+    parser_create_exp.add_argument(
+        "name",
+        help="Name of the experiment, if it ends with '-', a timestamp will be appended. Example: 'exp-' will become 'exp-2023-10-01-123456'",
+    )
+    parser_create_exp.add_argument(
+        "-f",
+        "--config",
+        default=os.path.expandvars("$HOME/.hive/sandbox-config.yaml"),
+        help="Path to the config file, default to ~/.hive/sandbox-config.yaml",
+    )
+    parser_create_exp.set_defaults(func=create_experiment)
+
+    # TODO:
+    # update command
+    # parser_update = subparsers.add_parser("update", help="Update resources")
+    # update_subparsers = parser_update.add_subparsers(dest="update_target")
+
+    # parser_update_exp = update_subparsers.add_parser(
+    #     "experiment", aliases=["exp"], help="Update an experiment"
+    # )
+    # parser_update_exp.add_argument("name", help="Name of the experiment")
+    # parser_update_exp.add_argument(
+    #     "-f",
+    #     "--config",
+    #     default=os.path.expandvars("$HOME/.hive/sandbox-config.yaml"),
+    #     help="Path to the config file, default to ~/.hive/sandbox-config.yaml",
+    # )
+    # parser_update_exp.set_defaults(func=update_experiment)
+
+    # delete command
+    parser_delete = subparsers.add_parser("delete", help="Delete resources")
+    delete_subparsers = parser_delete.add_subparsers(dest="delete_target")
+    parser_delete_exp = delete_subparsers.add_parser(
+        "experiment", aliases=["exp"], help="Delete an experiment"
+    )
+    parser_delete_exp.add_argument("name", help="Name of the experiment")
+    parser_delete_exp.add_argument(
+        "-p",
+        "--platform",
+        default="k8s",
+        choices=PLATFORMS.keys(),
+        help="Platform to use, k8s or on-prem, default to use k8s",
+    )
+    parser_delete_exp.add_argument(
+        "-f",
+        "--config",
+        default=os.path.expandvars("$HOME/.hive/sandbox-config.yaml"),
+        help="Path to the config file, default to ~/.hive/sandbox-config.yaml",
+    )
+    parser_delete_exp.set_defaults(func=delete_experiment)
+
+    # show command
+    parser_show = subparsers.add_parser("show", help="Show resources")
+    show_subparsers = parser_show.add_subparsers(dest="show_target")
+    parser_show_exp = show_subparsers.add_parser(
+        "experiments", aliases=["exp", "exps"], help="Show experiments"
+    )
+    parser_show_exp.add_argument(
+        "-p",
+        "--platform",
+        default="k8s",
+        choices=PLATFORMS.keys(),
+        help="Platform to use, k8s or on-prem, default to use k8s",
+    )
+    parser_show_exp.add_argument(
+        "-f",
+        "--config",
+        default=os.path.expandvars("$HOME/.hive/sandbox-config.yaml"),
+        help="Path to the config file, default to ~/.hive/sandbox-config.yaml",
+    )
+    parser_show_exp.set_defaults(func=show_experiment)
+
+    # edit command
+    parser_edit = subparsers.add_parser("edit", help="Edit Hive configuration")
+    edit_subparsers = parser_edit.add_subparsers(dest="edit_target")
+    parser_edit_config = edit_subparsers.add_parser(
+        "config", help="Edit the Hive configuration file"
+    )
+    parser_edit_config.add_argument(
+        "-f",
+        "--config",
+        default=os.path.expandvars("$HOME/.hive/sandbox-config.yaml"),
+        help="Path to the config file, defaults to ~/.hive/sandbox-config.yaml",
+    )
+    parser_edit_config.set_defaults(func=edit)
+
+    # dashboard command
+    parser_dashboard = subparsers.add_parser("dashboard", help="Open the Hive dashboard")
+    parser_dashboard.add_argument(
+        "--port",
+        default=8080,
+        type=int,
+        help="Port to run the dashboard on, default to 8080",
+    )
+    parser_dashboard.add_argument(
+        "-f",
+        "--config",
+        default=os.path.expandvars("$HOME/.hive/sandbox-config.yaml"),
+        help="Path to the config file, default to ~/.hive/sandbox-config.yaml",
+    )
+    parser_dashboard.add_argument(
+        "-p",
+        "--platform",
+        default="k8s",
+        choices=PLATFORMS.keys(),
+        help="Platform to use, k8s or on-prem, default to use k8s",
+    )
+    parser_dashboard.set_defaults(func=show_dashboard)
+
+    args = parser.parse_args()
+    if hasattr(args, "func"):
+        args.func(args)
+    else:
+        parser.print_help()

hiverge_cli-0.1.0/src/hive_cli/platform/base.py

@@ -0,0 +1,170 @@
+import os
+import shutil
+import tempfile
+from abc import ABC, abstractmethod
+from pathlib import Path
+
+from hive_cli.config import HiveConfig
+from hive_cli.runtime.runtime import Runtime
+from hive_cli.utils import git
+from hive_cli.utils.image import build_image
+from hive_cli.utils.logger import logger
+
+
+class Platform(Runtime, ABC):
+    @abstractmethod
+    def create(self, config: HiveConfig):
+        pass
+
+    @abstractmethod
+    def update(self, name: str, config: HiveConfig):
+        pass
+
+    @abstractmethod
+    def delete(self, name: str):
+        pass
+
+    @abstractmethod
+    def login(self, args):
+        pass
+
+    @abstractmethod
+    def show_experiments(self, args):
+        pass
+
+    @abstractmethod
+    def show_dashboard(self, args):
+        pass
+
+    def __init__(self, name: str, token_path: str = None):
+        super().__init__(name, token_path)
+
+    # setup_environment function can be used to prepare the environment for the experiment,
+    # shared logic for both K8s and OnPrem platforms.
+    def setup_environment(self, config: HiveConfig) -> HiveConfig:
+        """
+        Set up the environment for the experiment.
+        This includes building the Docker image and preparing any necessary resources.
+
+        Args:
+            config (HiveConfig): The configuration for the experiment.
+
+        Returns:
+            HiveConfig: The updated configuration with the image name set.
+        """
+
+        logger.info(f"Setting up environment for experiment '{self.experiment_name}'")
+        logger.debug(f"The HiveConfig: {config}")
+
+        # Here you can add more setup logic, like initializing Kubernetes resources
+        # or configuring the environment based on the HiveConfig.
+        with tempfile.TemporaryDirectory(dir="./tmp") as temp_dir:
+            image_name = self.prepare_images(config, temp_dir, push=True)
+
+            # Populate related fields to the config, only allow to update here.
+            config.sandbox.image = image_name
+
+        logger.debug(f"The updated HiveConfig: {config}")
+        return config
+
+    def prepare_images(self, config: HiveConfig, temp_dir: str, push: bool = False) -> str:
+        """
+        Build the Docker image for the experiment.
+        If `push` is True, it will push the image to the registry.
+
+        Args:
+            config (HiveConfig): The configuration for the experiment.
+            temp_dir (str): The temporary directory to use for building the image.
+            push (bool): Whether to push the image to the registry.
+
+        Returns:
+            str: The name of the built image.
+        """
+
+        logger.debug(f"Preparing images for experiment '{self.experiment_name}' in {temp_dir}")
+
+        # TODO: refactor this part to use an image by default rather than build from the scratch.
+        shutil.copytree(
+            "./libs",
+            Path("./tmp") / temp_dir,
+            dirs_exist_ok=True,
+        )
+        dest = Path(temp_dir) / "repo"
+
+        git.clone_repo(config.repo.url, dest, config.repo.branch)
+        logger.debug(
+            f"Cloning repository {config.repo.url} to {dest}, the tree structure of the directory: {os.listdir('.')}, the tree structure of the {dest} directory: {os.listdir(dest)}"
+        )
+
+        if not (dest / "Dockerfile").exists():
+            logger.debug(f"No Dockerfile found in {dest}, generating one.")
+            # Generate Dockerfile for the experiment
+            generate_dockerfile(dest)
+
+        logger.debug(f"Building temporary repo image in {dest}")
+        # build the repository image first
+        build_image(
+            image="repo-image:latest",
+            context=dest,
+            dockerfile=dest / "Dockerfile",
+            # this is a temporary image, so we don't push it
+            push=False,
+        )
+
+        if config.cloud_provider.gcp and config.cloud_provider.gcp.enabled:
+            image_registry = config.cloud_provider.gcp.image_registry
+        elif config.cloud_provider.aws and config.cloud_provider.aws.enabled:
+            image_registry = config.cloud_provider.aws.image_registry
+        else:
+            raise ValueError("Unsupported cloud provider configuration. Please enable GCP or AWS.")
+
+        image_name = f"{image_registry}:{self.experiment_name}"
+
+        logger.debug(f"Building sandbox image {image_name} in {temp_dir} with push={push}")
+        # build the sandbox image
+        build_image(
+            image=image_name,
+            context=temp_dir,
+            dockerfile=f"{temp_dir}/Dockerfile",
+            push=push,
+        )
+
+        logger.debug(
+            f"Images {image_name} prepared for experiment '{self.experiment_name}' successfully."
+        )
+        return image_name
+
+
+# copied from the original hiverge project.
+def generate_dockerfile(dest: Path) -> None:
+    """Create a Dockerfile inside `dest`."""
+    lines = [
+        "FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim",
+        "",
+        "RUN apt-get update && apt-get install --no-install-recommends -y \\",
+        "cmake \\",
+        "build-essential \\",
+        "pkg-config \\",
+        "&& rm -rf /var/lib/apt/lists/*",
+        "",
+        "WORKDIR /app",
+        "",
+        "# Install sandbox server dependencies",
+    ]
+    if (dest / "pyproject.toml").exists():
+        lines.append("# Install repository dependencies from pyproject.toml")
+        lines.append("COPY pyproject.toml .")
+        lines.append("RUN uv pip install --system --requirement pyproject.toml")
+    elif (dest / "requirements.txt").exists():
+        lines.append("# Install repository dependencies from requirements.txt")
+        lines.append("COPY requirements.txt .")
+        lines.append("RUN uv pip install --system --requirement requirements.txt")
+
+    lines.extend(
+        [
+            "",
+            "# Copy server code and evaluation file",
+            "COPY . repo",
+        ]
+    )
+    (dest / "Dockerfile").write_text("\n".join(lines), encoding="utf-8")

hiverge_cli-0.1.0/src/hive_cli/platform/k8s.py

@@ -0,0 +1,232 @@
+import subprocess
+
+from kubernetes import client
+from kubernetes import config as k8s_config
+from kubernetes.client.api_client import ApiClient
+from kubernetes.client.rest import ApiException
+from rich.console import Console
+from rich.table import Table
+from rich.text import Text
+
+from hive_cli.config import HiveConfig
+from hive_cli.platform.base import Platform
+from hive_cli.utils.logger import logger
+from hive_cli.utils.time import humanize_time
+
+GROUP = "core.hiverge.ai"
+VERSION = "v1alpha1"
+RESOURCE = "Experiment"
+RESOURCE_PLURAL = "experiments"
+# TODO: remove this once we support custom namespace
+NAMESPACE = "default"
+
+
+class K8sPlatform(Platform):
+    def __init__(self, name: str, token_path: str = None):
+        super().__init__(name, token_path)
+
+        k8s_config.load_kube_config(config_file=token_path)
+        self.client = client.CustomObjectsApi()
+
+    def create(self, config: HiveConfig):
+        logger.info(f"Creating experiment '{self.experiment_name}' on Kubernetes...")
+        config = self.setup_environment(config)
+        deploy("CREATE", self.client, self.experiment_name, config)
+
+    def update(self, name: str, config: HiveConfig):
+        logger.info(f"Updating experiment '{name}' on Kubernetes...")
+        deploy("UPDATE", self.client, name, config)
+
+    def delete(self, name: str):
+        logger.info(f"Deleting experiment '{name}' on Kubernetes...")
+        try:
+            # Attempt to delete the experiment by its name
+            self.client.delete_namespaced_custom_object(
+                group=GROUP,
+                version=VERSION,
+                namespace=NAMESPACE,
+                plural=RESOURCE_PLURAL,
+                name=name,
+            )
+            logger.info(f"Experiment '{name}' deleted successfully on Kubernetes.")
+        except ApiException as e:
+            logger.error(f"Failed to delete experiment '{name}' on Kubernetes: {e}")
+        except Exception as e:
+            logger.error(f"An unexpected error occurred while deleting experiment '{name}': {e}")
+
+    def login(self, args):
+        logger.info(f"Logging in to hive on {args.platform} platform...")
+
+    def show_experiments(self, args):
+        resp = self.client.list_namespaced_custom_object(
+            group=GROUP,
+            version=VERSION,
+            namespace=NAMESPACE,
+            plural=RESOURCE_PLURAL,
+        )
+
+        table = Table(show_header=True, header_style="bold", box=None, show_lines=False)
+        table.add_column("Name")
+        table.add_column("Status")
+        table.add_column("Sandboxes")
+        table.add_column("Age")
+
+        for item in resp.get("items", []):
+            metadata = item.get("metadata", {})
+            age = humanize_time(metadata.get("creationTimestamp"))
+            status = item.get("status", {}).get("phase", "Unknown")
+            replicas = item.get("status", {}).get("sandboxReplicas", 0)
+            unavailable_replicas = item.get("status", {}).get("sandboxUnavailableReplicas", 0)
+
+            table.add_row(
+                metadata.get("name", "Unknown"),
+                status,
+                f"{replicas - unavailable_replicas}/{replicas}",
+                age if age else "N/A",
+            )
+
+        console = Console()
+        console.print(table)
+
+    def show_dashboard(self, args):
+        resp = self.client.list_namespaced_custom_object(
+            group=GROUP,
+            version=VERSION,
+            namespace=NAMESPACE,
+            plural=RESOURCE_PLURAL,
+        )
+
+        for item in resp.get("items", []):
+            metadata = item.get("metadata", {})
+            name = metadata.get("name", "Unknown")
+
+            console = Console()
+            url = f"http://localhost:{args.port}"
+            msg = Text("Open Hive dashboard at ", style="bold green")
+            msg.append(url, style="bold magenta")
+            msg.append(" ...", style="dim")
+            console.print(msg)
+
+            commands = [
+                "kubectl",
+                f"--kubeconfig={self.token_path}",
+                "port-forward",
+                f"svc/{name}-dashboard-frontend",
+                f"{str(args.port)}:8080",
+            ]
+            process = subprocess.Popen(
+                commands, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True
+            )
+            try:
+                process.wait()
+            except KeyboardInterrupt:
+                pass
+
+            return
+
+
+def deploy(op: str, client: ApiClient, name: str, config: HiveConfig):
+    logger.info(f"Applying experiment '{name}' on Kubernetes...")
+
+    body = construct_experiment(name, NAMESPACE, config)
+
+    try:
+        if op == "CREATE":
+            resp = client.create_namespaced_custom_object(
+                group=GROUP, version=VERSION, namespace=NAMESPACE, plural=RESOURCE_PLURAL, body=body
+            )
+            logger.info(
+                f"Experiment '{name}' created successfully on Kubernetes with name {resp['metadata']['name']}."
+            )
+        # TODO: add validation for op, only replicas can be updated
+        elif op == "UPDATE":
+            current_exp = client.get_namespaced_custom_object(
+                group=GROUP, version=VERSION, namespace=NAMESPACE, plural=RESOURCE_PLURAL, name=name
+            )
+
+            # Populate some fields manually because they're generated in creation.
+            if body["spec"]["sandbox"].get("image") is None:
+                body["spec"]["sandbox"]["image"] = current_exp["spec"]["sandbox"]["image"]
+
+            resp = client.patch_namespaced_custom_object(
+                group=GROUP,
+                version=VERSION,
+                namespace=NAMESPACE,
+                plural=RESOURCE_PLURAL,
+                name=name,
+                body=body,
+            )
+            logger.info(
+                f"Experiment '{name}' updated successfully on Kubernetes with name {resp['metadata']['name']}."
+            )
+        else:
+            raise ValueError(
+                f"Unsupported operation: {op}. Supported operations are 'CREATE' and 'UPDATE'."
+            )
+    except ApiException as e:
+        logger.error(f"Failed to deploy experiment '{name}' on Kubernetes: {e}")
+    except Exception as e:
+        logger.error(f"An unexpected error occurred while deploying experiment '{name}': {e}")
+
+
+def construct_experiment(name: str, namespace: str, config: HiveConfig) -> dict:
+    """
+    Constructs a Kubernetes custom resource definition (CRD) for an experiment.
+
+    Args:
+        name (str): The name of the experiment.
+        namespace (str): The Kubernetes namespace where the experiment will be deployed.
+
+    Returns:
+        dict: A dictionary representing the CRD for the experiment.
+    """
+
+    if config.cloud_provider.gcp and config.cloud_provider.gcp.enabled:
+        cloud_provider_name = "gcp"
+    elif config.cloud_provider.aws and config.cloud_provider.aws.enabled:
+        cloud_provider_name = "aws"
+    else:
+        cloud_provider_name = "unknown"
+
+    if config.sandbox.envs is not None:
+        envs = [env.model_dump() for env in config.sandbox.envs]
+    else:
+        envs = None
+
+    if config.sandbox.resources is not None:
+        resources = config.sandbox.resources.model_dump()
+    else:
+        resources = {}
+
+    result = {
+        "apiVersion": f"{GROUP}/{VERSION}",
+        "kind": RESOURCE,
+        "metadata": {
+            "name": name,
+            "namespace": namespace,
+        },
+        "spec": {
+            "projectName": config.project_name,
+            "coordinatorConfigName": config.coordinator_config_name,
+            "sandbox": {
+                "image": config.sandbox.image,
+                "replicas": config.sandbox.replicas,
+                "timeout": config.sandbox.timeout,
+                "resources": resources,
+                "envs": envs,
+                "preprocessor": config.sandbox.pre_processor,
+            },
+            "repo": {
+                "url": config.repo.url,
+                "branch": config.repo.branch,
+                "evaluationScript": config.repo.evaluation_script,
+                "evolveFilesAndRanges": config.repo.evolve_files_and_ranges,
+            },
+            "cloudProvider": {
+                "spot": config.cloud_provider.spot,
+                "name": cloud_provider_name,
+            },
+        },
+    }
+
+    return result

hiverge_cli-0.1.0/src/hive_cli/platform/onprem.py

@@ -0,0 +1,26 @@
+from hive_cli.config import HiveConfig
+
+from .base import Platform
+
+
+class OnPremPlatform(Platform):
+    def __init__(self, name: str):
+        super().__init__(name)
+
+    def create(self, config: HiveConfig):
+        print(f"Creating hive on-premise with name: {self.experiment_name} and config: {config}")
+
+    def update(self, name: str, config: HiveConfig):
+        print(f"Updating hive on-premise with name: {name} and config: {config}")
+
+    def delete(self, name: str):
+        print("Deleting hive on-premise...")
+
+    def login(self, args):
+        print("Logging in to hive on-premise...")
+
+    def show_experiments(self, args):
+        print("Showing experiments on-premise...")
+
+    def show_dashboard(self, args):
+        print("Showing dashboard on-premise...")

hiverge_cli-0.1.0/src/hive_cli/runtime/runtime.py

@@ -0,0 +1,28 @@
+import hashlib
+from datetime import datetime, timezone
+
+
+class Runtime:
+    def __init__(self, name: str, token_path: str = None):
+        """Initialize the Runtime with a name.
+        This can be used to set up any necessary runtime configurations.
+        """
+
+        self.token_path = token_path
+        self.experiment_name = generate_experiment_name(name)
+
+
+def generate_experiment_name(base_name: str) -> str:
+    """
+    Generate a unique experiment name based on the base name and current timestamp.
+    If the base name ends with '-', it will be suffixed with a timestamp.
+    """
+
+    experiment_name = base_name
+
+    if base_name.endswith("-"):
+        timestamp = str(int(datetime.now(timezone.utc).timestamp()))
+        unique_hash = hashlib.sha1(timestamp.encode()).hexdigest()[:12]
+        experiment_name = f"{base_name}{unique_hash}"
+
+    return experiment_name

hiverge_cli-0.1.0/src/hive_cli/utils/git.py

@@ -0,0 +1,25 @@
+import os
+import shutil
+from pathlib import Path
+
+import git
+
+
+def clone_repo(repo_dir: str, output_dir: str, branch: str = "main") -> None:
+    """Clone a repository into the output directory."""
+    dest = Path(output_dir)
+    dest.mkdir(parents=True, exist_ok=True)
+    if repo_dir.startswith("https://"):
+        token = os.getenv("GITHUB_TOKEN")
+        if token:
+            # Inject token into the URL for authentication
+            repo_dir = repo_dir.replace("https://", f"https://x-access-token:{token}@")
+        repo = git.Repo.clone_from(repo_dir, dest)
+        repo.git.checkout(branch)
+    else:  # We assume `repo_dir` is a directory in this machine.
+        repo_path = Path(repo_dir).resolve()
+        if not repo_path.exists():
+            raise FileNotFoundError(f"Repository directory {repo_dir} does not exist")
+        if not repo_path.is_dir():
+            raise NotADirectoryError(f"{repo_dir} is not a directory")
+        shutil.copytree(repo_path, dest, dirs_exist_ok=True)

hiverge_cli-0.1.0/src/hive_cli/utils/image.py

@@ -0,0 +1,44 @@
+import logging
+import subprocess
+
+from hive_cli.utils.logger import logger
+
+
+def build_image(
+    image: str,
+    platforms: str = "linux/amd64,linux/arm64",
+    context: str = ".",
+    dockerfile: str = "Dockerfile",
+    push: bool = False,
+):
+    cmd = [
+        "docker",
+        "buildx",
+        "build",
+        "--platform",
+        platforms,
+        "--file",
+        dockerfile,
+        "--tag",
+        image,
+        "--load",
+        context,
+    ]
+    if push:
+        cmd.append("--push")
+
+    try:
+        if logger.isEnabledFor(logging.DEBUG):
+            capture_output = False
+        else:
+            capture_output = True
+
+        subprocess.run(
+            cmd,
+            check=True,
+            capture_output=capture_output,
+            text=True,
+        )
+    except subprocess.CalledProcessError as e:
+        print("Build STDERR:\n", e.stderr)
+        raise

hiverge_cli-0.1.0/src/hive_cli/utils/logger.py

@@ -0,0 +1,32 @@
+import logging
+import os
+
+from dotenv import load_dotenv
+from rich.logging import RichHandler
+
+# load the .env file.
+load_dotenv()
+
+
+def setup_logging(name: str) -> logging.Logger:
+    """
+    Set up a logger with the specified name and logging level.
+    If no level is provided, it defaults to INFO.
+    """
+
+    log_level = os.getenv("LOG_LEVEL", "INFO").upper()  # Default log level
+
+    logging.basicConfig(
+        level=log_level,
+        format="%(name)s %(message)s",
+        handlers=[
+            RichHandler(
+                show_time=True, show_level=True, show_path=False, markup=True, rich_tracebacks=True
+            )
+        ],
+    )
+
+    return logging.getLogger(name)
+
+
+logger = setup_logging("hive-cli")

hiverge_cli-0.1.0/src/hive_cli/utils/time.py

@@ -0,0 +1,19 @@
+import datetime
+
+
+def humanize_time(timestamp: str) -> str:
+    creation_time = datetime.datetime.strptime(timestamp, "%Y-%m-%dT%H:%M:%SZ").replace(
+        tzinfo=datetime.UTC
+    )
+    t = datetime.datetime.now(datetime.UTC) - creation_time
+
+    if t.days > 0:
+        age = f"{t.days}d"
+    elif t.seconds >= 3600:
+        age = f"{t.seconds // 3600}h"
+    elif t.seconds >= 60:
+        age = f"{t.seconds // 60}m"
+    else:
+        age = f"{t.seconds}s"
+
+    return age

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

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: hiverge-cli
+Version: 0.1.0
+Summary: Universal Command Line Interface for Hive agent.
+Author: Hiverge Team
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=5.1
+Requires-Dist: pydantic>=1.8.2
+Requires-Dist: gitpython>=3.1.24
+Requires-Dist: python-dotenv>=0.19.2
+Requires-Dist: rich>=12.5.1
+Requires-Dist: kubernetes>=32.0.0
+Provides-Extra: test
+Provides-Extra: dev
+Requires-Dist: ruff>=0.12; extra == "dev"
+Dynamic: license-file
+
+# Hive-CLI
+
+Hive-CLI is a command-line interface for managing and deploying Hive agent and experiments on Kubernetes and other platforms.
+
+```bash
+     ███          █████   █████  ███
+    ░░░███       ░░███   ░░███  ░░░
+      ░░░███      ░███    ░███  ████  █████ █████  ██████
+        ░░░███    ░███████████ ░░███ ░░███ ░░███  ███░░███
+         ███░     ░███░░░░░███  ░███  ░███  ░███ ░███████
+       ███░       ░███    ░███  ░███  ░░███ ███  ░███░░░
+     ███░         █████   █████ █████  ░░█████   ░░██████
+    ░░░          ░░░░░   ░░░░░ ░░░░░    ░░░░░     ░░░░░░
+```
+
+## Installation
+
+### Install via pip (Not-Available Yet)
+
+```bash
+pip install hive-cli
+```
+
+### Install from source
+
+```bash
+source start.sh
+```
+
+## How to run
+
+**Note**: Hive-CLI reads the configuration from a yaml file, by default it will look for the `~/.hive/sandbox-config.yaml`. You can also specify a different configuration file using the `-f` option. Refer to the [config.yaml](./config.yaml) for examples.
+
+Below we assume that you have a `~/.hive/sandbox-config.yaml` file.
+
+### Edit the experiment
+
+`Edit` command will open the configuration file in your default editor (e.g., vim, nano, etc.) for you to modify the experiment configuration. You can also specify a different editor using the `EDITOR` environment variable, by default it will use `vim`.
+
+```bash
+hive edit config
+```
+
+### Create an experiment
+
+```bash
+hive create exp my-experiment
+```
+
+### List experiments
+
+```bash
+hive show exps
+```
+
+### Visit Dashboard
+
+```bash
+hive dashboard
+```
+
+### Delete an experiment
+
+
+```bash
+hive delete exp my-experiment
+```
+
+### More
+
+See `hive -h` for more details.
+
+## Development
+
+**Note**: Hive-CLI will read the `.env` file to load logging configurations. Refer to the `.env.example` file for examples.
+
+### Debugging
+
+Change the log level in `.env` file to `DEBUG` to see more detailed logs.

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

@@ -0,0 +1,24 @@
+LICENSE
+README.md
+pyproject.toml
+src/hive_cli/__init__.py
+src/hive_cli/config.py
+src/hive_cli/main.py
+src/hive_cli/platform/__init__.py
+src/hive_cli/platform/base.py
+src/hive_cli/platform/k8s.py
+src/hive_cli/platform/onprem.py
+src/hive_cli/runtime/__init__.py
+src/hive_cli/runtime/runtime.py
+src/hive_cli/utils/__init__.py
+src/hive_cli/utils/git.py
+src/hive_cli/utils/image.py
+src/hive_cli/utils/logger.py
+src/hive_cli/utils/time.py
+src/hiverge_cli.egg-info/PKG-INFO
+src/hiverge_cli.egg-info/SOURCES.txt
+src/hiverge_cli.egg-info/dependency_links.txt
+src/hiverge_cli.egg-info/entry_points.txt
+src/hiverge_cli.egg-info/requires.txt
+src/hiverge_cli.egg-info/top_level.txt
+tests/test_main.py

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1,2 @@
+[console_scripts]
+hive = hive_cli.main:main

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

@@ -0,0 +1,11 @@
+PyYAML>=5.1
+pydantic>=1.8.2
+gitpython>=3.1.24
+python-dotenv>=0.19.2
+rich>=12.5.1
+kubernetes>=32.0.0
+
+[dev]
+ruff>=0.12
+
+[test]

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

@@ -0,0 +1 @@
+hive_cli

hiverge_cli-0.1.0/tests/test_main.py

@@ -0,0 +1,2 @@
+def test_main():
+    pass