bitsreef-cli 0.1.0__tar.gz

bitsreef_cli-0.1.0/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: bitsreef-cli
+Version: 0.1.0
+Summary: CLI tool for BitsReef PaaS platform
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.1
+Requires-Dist: httpx>=0.25
+Requires-Dist: rich>=13.0
+Requires-Dist: websocket-client>=1.6
+
+# BitsReef CLI
+
+`bitsreef` — deploy and manage BitsReef services from the command line.
+
+## Install
+
+```bash
+# One-liner (installs via pipx, or an isolated venv as fallback):
+curl -fsSL https://raw.githubusercontent.com/cygnaragroup/bitsreef/main/cli/install.sh | sh
+
+# ...or with pip / pipx directly:
+pipx install bitsreef-cli      # recommended — isolated, on PATH
+pip install bitsreef-cli
+
+# ...or from a checkout:
+pip install -e cli/
+```
+
+### Shell completion
+
+```bash
+eval "$(bitsreef completion bash)"   # add to ~/.bashrc
+eval "$(bitsreef completion zsh)"    # add to ~/.zshrc
+bitsreef completion fish > ~/.config/fish/completions/bitsreef.fish
+```
+
+## Getting started
+
+```bash
+# Log in to BitsReef (the CLI talks to the hosted BitsReef API)
+bitsreef auth login
+
+# Deploy an image to a project in one shot, streaming to completion
+bitsreef up --project 4 --name web --image nginx:latest --port 80 --follow
+```
+
+`bitsreef up` creates the service if it doesn't exist (or updates its image if
+it does), triggers a deployment, and with `--follow` streams the build/deploy
+logs and exits non-zero if the deploy fails — so it drops straight into CI.
+
+## Linking (stop typing IDs)
+
+Bind a directory to a project/service once, then omit IDs everywhere:
+
+```bash
+bitsreef link --project demo --service web   # writes ./.bitsreef.json
+bitsreef logs                                # → the linked service's logs
+bitsreef up -i nginx:1.27 --follow           # redeploy the linked service
+bitsreef deploy status                       # linked project's deployments
+bitsreef link --show                         # what's linked here
+bitsreef unlink                              # remove the link
+```
+
+The link file (`.bitsreef.json`) is discovered by walking up from the current
+directory, like `.git`. **Names or slugs work in place of numeric IDs**
+everywhere (`bitsreef logs demo web`), and a default org is remembered after the
+first pick so multi-org accounts stop re-prompting.
+
+## Commands
+
+| Command | Purpose |
+|---|---|
+| `up` | Create-or-update a service from an image and deploy it (`--follow`, `--json`) |
+| `exec` | Open an interactive shell (`/bin/sh`) in a running container |
+| `link` / `unlink` | Bind this directory to a project/service (`--show`) |
+| `auth` | `login`, `logout`, `whoami` |
+| `projects` | `list`, `info`, `create` |
+| `services` | `list`, `info`, `restart`, `stop`, `scale` |
+| `deploy` | `up` (`--follow`), `rebuild`, `status`, `rollback` |
+| `env` | `list`, `set`, `delete`, `reveal` |
+| `domains` | `list`, `add`, `remove`, `verify` (custom domains) |
+| `volumes` | `list`, `create`, `delete` |
+| `metrics` | Current CPU / memory / network snapshot for a service |
+| `cron` | `list`, `create`, `trigger`, `runs`, `delete` (scheduled jobs) |
+| `webhooks` | `list`, `add`, `update`, `remove` (project event notifications) |
+| `templates` | `list`, `info`, `deploy` (service templates) |
+| `functions` | `list`, `create`, `invoke`, `history`, `update`, `delete` |
+| `logs` | View service logs (`--tail`, `--follow` for a live tail) |
+| `completion` | Print a shell-completion script (`bash`, `zsh`, `fish`) |
+
+Run `bitsreef <command> --help` for full options.
+
+## CI / scripting / agents
+
+Everything works non-interactively and can emit JSON:
+
+```bash
+# Auth without a prompt — a token env var (nothing written to disk):
+export BITSREEF_TOKEN=<access-token>
+
+# ...or a piped password / a stored token:
+echo "$PASS" | bitsreef auth login -u ci --password-stdin
+bitsreef auth login --token "$BITSREEF_TOKEN"
+
+# Machine-readable output (place --json before the command):
+bitsreef --json services list demo | jq '.[].name'
+bitsreef --json whoami
+bitsreef up -p demo -n web -i img:tag --follow --json   # exits non-zero on deploy failure
+```
+
+`BITSREEF_TOKEN` (env) takes precedence over the config file. `--json` is
+supported on the read commands (`whoami`, `projects/services list|info`,
+`deploy status`, `env list`, `functions list|history`, `logs`) and `up`.
+
+## Configuration
+
+Config and JWT tokens live in `~/.bitsreef/config.json` (created `0600`). The
+access token is refreshed automatically on expiry. `BITSREEF_TOKEN` (env)
+overrides the file when set. The API endpoint is built into the CLI — BitsReef
+is a hosted service, so there is no server URL to configure.
+
+## Development
+
+```bash
+cd cli
+pip install -e . pytest
+pytest
+```
+
+### Releasing
+
+Publishing is automated by `.github/workflows/cli-publish.yml` via PyPI
+[trusted publishing](https://docs.pypi.org/trusted-publishers/) (no API token).
+Bump `version` in `pyproject.toml` and `bitsreef_cli/__init__.py`, then tag:
+
+```bash
+git tag cli-v0.1.0 && git push origin cli-v0.1.0
+```
+
+The workflow verifies the tag matches the package version, builds the sdist +
+wheel, `twine check`s them, and uploads to PyPI. It can also be run manually
+from the Actions tab (`workflow_dispatch`).

bitsreef_cli-0.1.0/README.md

@@ -0,0 +1,132 @@
+# BitsReef CLI
+
+`bitsreef` — deploy and manage BitsReef services from the command line.
+
+## Install
+
+```bash
+# One-liner (installs via pipx, or an isolated venv as fallback):
+curl -fsSL https://raw.githubusercontent.com/cygnaragroup/bitsreef/main/cli/install.sh | sh
+
+# ...or with pip / pipx directly:
+pipx install bitsreef-cli      # recommended — isolated, on PATH
+pip install bitsreef-cli
+
+# ...or from a checkout:
+pip install -e cli/
+```
+
+### Shell completion
+
+```bash
+eval "$(bitsreef completion bash)"   # add to ~/.bashrc
+eval "$(bitsreef completion zsh)"    # add to ~/.zshrc
+bitsreef completion fish > ~/.config/fish/completions/bitsreef.fish
+```
+
+## Getting started
+
+```bash
+# Log in to BitsReef (the CLI talks to the hosted BitsReef API)
+bitsreef auth login
+
+# Deploy an image to a project in one shot, streaming to completion
+bitsreef up --project 4 --name web --image nginx:latest --port 80 --follow
+```
+
+`bitsreef up` creates the service if it doesn't exist (or updates its image if
+it does), triggers a deployment, and with `--follow` streams the build/deploy
+logs and exits non-zero if the deploy fails — so it drops straight into CI.
+
+## Linking (stop typing IDs)
+
+Bind a directory to a project/service once, then omit IDs everywhere:
+
+```bash
+bitsreef link --project demo --service web   # writes ./.bitsreef.json
+bitsreef logs                                # → the linked service's logs
+bitsreef up -i nginx:1.27 --follow           # redeploy the linked service
+bitsreef deploy status                       # linked project's deployments
+bitsreef link --show                         # what's linked here
+bitsreef unlink                              # remove the link
+```
+
+The link file (`.bitsreef.json`) is discovered by walking up from the current
+directory, like `.git`. **Names or slugs work in place of numeric IDs**
+everywhere (`bitsreef logs demo web`), and a default org is remembered after the
+first pick so multi-org accounts stop re-prompting.
+
+## Commands
+
+| Command | Purpose |
+|---|---|
+| `up` | Create-or-update a service from an image and deploy it (`--follow`, `--json`) |
+| `exec` | Open an interactive shell (`/bin/sh`) in a running container |
+| `link` / `unlink` | Bind this directory to a project/service (`--show`) |
+| `auth` | `login`, `logout`, `whoami` |
+| `projects` | `list`, `info`, `create` |
+| `services` | `list`, `info`, `restart`, `stop`, `scale` |
+| `deploy` | `up` (`--follow`), `rebuild`, `status`, `rollback` |
+| `env` | `list`, `set`, `delete`, `reveal` |
+| `domains` | `list`, `add`, `remove`, `verify` (custom domains) |
+| `volumes` | `list`, `create`, `delete` |
+| `metrics` | Current CPU / memory / network snapshot for a service |
+| `cron` | `list`, `create`, `trigger`, `runs`, `delete` (scheduled jobs) |
+| `webhooks` | `list`, `add`, `update`, `remove` (project event notifications) |
+| `templates` | `list`, `info`, `deploy` (service templates) |
+| `functions` | `list`, `create`, `invoke`, `history`, `update`, `delete` |
+| `logs` | View service logs (`--tail`, `--follow` for a live tail) |
+| `completion` | Print a shell-completion script (`bash`, `zsh`, `fish`) |
+
+Run `bitsreef <command> --help` for full options.
+
+## CI / scripting / agents
+
+Everything works non-interactively and can emit JSON:
+
+```bash
+# Auth without a prompt — a token env var (nothing written to disk):
+export BITSREEF_TOKEN=<access-token>
+
+# ...or a piped password / a stored token:
+echo "$PASS" | bitsreef auth login -u ci --password-stdin
+bitsreef auth login --token "$BITSREEF_TOKEN"
+
+# Machine-readable output (place --json before the command):
+bitsreef --json services list demo | jq '.[].name'
+bitsreef --json whoami
+bitsreef up -p demo -n web -i img:tag --follow --json   # exits non-zero on deploy failure
+```
+
+`BITSREEF_TOKEN` (env) takes precedence over the config file. `--json` is
+supported on the read commands (`whoami`, `projects/services list|info`,
+`deploy status`, `env list`, `functions list|history`, `logs`) and `up`.
+
+## Configuration
+
+Config and JWT tokens live in `~/.bitsreef/config.json` (created `0600`). The
+access token is refreshed automatically on expiry. `BITSREEF_TOKEN` (env)
+overrides the file when set. The API endpoint is built into the CLI — BitsReef
+is a hosted service, so there is no server URL to configure.
+
+## Development
+
+```bash
+cd cli
+pip install -e . pytest
+pytest
+```
+
+### Releasing
+
+Publishing is automated by `.github/workflows/cli-publish.yml` via PyPI
+[trusted publishing](https://docs.pypi.org/trusted-publishers/) (no API token).
+Bump `version` in `pyproject.toml` and `bitsreef_cli/__init__.py`, then tag:
+
+```bash
+git tag cli-v0.1.0 && git push origin cli-v0.1.0
+```
+
+The workflow verifies the tag matches the package version, builds the sdist +
+wheel, `twine check`s them, and uploads to PyPI. It can also be run manually
+from the Actions tab (`workflow_dispatch`).

bitsreef_cli-0.1.0/bitsreef_cli/__init__.py

@@ -0,0 +1,2 @@
+"""BitsReef CLI — command-line interface for the BitsReef PaaS platform."""
+__version__ = "0.1.0"

bitsreef_cli-0.1.0/bitsreef_cli/client.py

@@ -0,0 +1,74 @@
+"""HTTP client for BitsReef API with automatic token refresh."""
+import sys
+
+import click
+import httpx
+
+from . import config
+
+
+class BitsReefClient:
+    """Authenticated HTTP client for the BitsReef API."""
+
+    def __init__(self):
+        self.base_url = config.get_api_url()
+        access, refresh = config.get_tokens()
+        self.access_token = access
+        self.refresh_token = refresh
+
+    def _headers(self) -> dict:
+        h = {"Content-Type": "application/json"}
+        if self.access_token:
+            h["Authorization"] = f"Bearer {self.access_token}"
+        return h
+
+    def _refresh(self) -> bool:
+        """Attempt to refresh the access token. Returns True on success."""
+        if not self.refresh_token:
+            return False
+        try:
+            resp = httpx.post(
+                f"{self.base_url}/account/token/refresh/",
+                json={"refresh": self.refresh_token},
+                timeout=10,
+            )
+            if resp.status_code == 200:
+                data = resp.json()
+                self.access_token = data["access"]
+                config.save_tokens(self.access_token, self.refresh_token)
+                return True
+        except httpx.HTTPError:
+            pass
+        return False
+
+    def request(self, method: str, path: str, **kwargs) -> httpx.Response:
+        """Make an authenticated request. Auto-refreshes token on 401."""
+        url = f"{self.base_url}{path}"
+        resp = httpx.request(method, url, headers=self._headers(), timeout=30, **kwargs)
+        if resp.status_code == 401 and self._refresh():
+            resp = httpx.request(method, url, headers=self._headers(), timeout=30, **kwargs)
+        if resp.status_code == 401:
+            click.secho("Session expired. Please run: bitsreef auth login", fg="red")
+            sys.exit(1)
+        return resp
+
+    def get(self, path: str, **kwargs) -> httpx.Response:
+        return self.request("GET", path, **kwargs)
+
+    def post(self, path: str, **kwargs) -> httpx.Response:
+        return self.request("POST", path, **kwargs)
+
+    def patch(self, path: str, **kwargs) -> httpx.Response:
+        return self.request("PATCH", path, **kwargs)
+
+    def delete(self, path: str, **kwargs) -> httpx.Response:
+        return self.request("DELETE", path, **kwargs)
+
+
+def get_client() -> BitsReefClient:
+    """Return an authenticated client, exiting if not logged in."""
+    access, _ = config.get_tokens()
+    if not access:
+        click.secho("Not logged in. Run: bitsreef auth login", fg="red")
+        sys.exit(1)
+    return BitsReefClient()

bitsreef_cli-0.1.0/bitsreef_cli/commands/auth.py

@@ -0,0 +1,91 @@
+"""Auth commands: login, logout, whoami."""
+import sys
+
+import click
+import httpx
+from rich.console import Console
+
+from .. import config, output
+
+console = Console()
+
+
+@click.group()
+def auth():
+    """Authenticate with BitsReef."""
+
+
+@auth.command()
+@click.option("--username", "-u", default=None, help="Username (else prompted)")
+@click.option("--password-stdin", "password_stdin", is_flag=True,
+              help="Read the password from stdin (non-interactive, for CI)")
+@click.option("--token", default=None,
+              help="Store a pre-issued access token instead of logging in")
+def login(username, password_stdin, token):
+    """Log in with username/password, or store a token non-interactively.
+
+    The CLI always talks to the hosted BitsReef API — there is no server URL to
+    set.
+
+    CI examples:
+        echo "$PASS" | bitsreef auth login -u ci --password-stdin
+        bitsreef auth login --token "$BITSREEF_TOKEN"
+    (Or skip login entirely and set BITSREEF_TOKEN.)
+    """
+    api_url = config.get_api_url()
+
+    # Non-interactive: store a pre-issued access token (no refresh token).
+    if token:
+        config.save_tokens(token, "")
+        console.print(f"[green]Token stored[/green] for {api_url}")
+        return
+
+    if not username:
+        username = click.prompt("Username")
+    if password_stdin:
+        password = sys.stdin.readline().rstrip("\n")
+    else:
+        password = click.prompt("Password", hide_input=True)
+
+    try:
+        resp = httpx.post(
+            f"{api_url}/account/token/",
+            json={"username": username, "password": password},
+            timeout=15,
+        )
+    except httpx.ConnectError:
+        console.print(f"[red]Cannot connect to {api_url}[/red]")
+        raise SystemExit(1)
+
+    if resp.status_code != 200:
+        console.print("[red]Login failed — check username/password.[/red]")
+        raise SystemExit(1)
+
+    data = resp.json()
+    config.save_tokens(data["access"], data["refresh"])
+    console.print(f"[green]Logged in as [bold]{username}[/bold][/green]")
+
+
+@auth.command()
+def logout():
+    """Log out and clear stored tokens."""
+    config.clear_tokens()
+    console.print("[green]Logged out.[/green]")
+
+
+@auth.command()
+def whoami():
+    """Show the current logged-in user."""
+    from ..client import get_client
+
+    client = get_client()
+    resp = client.get("/account/me/")
+    if resp.status_code != 200:
+        console.print("[red]Could not fetch user info.[/red]")
+        raise SystemExit(1)
+
+    user = resp.json()
+    if output.json_enabled():
+        output.emit(user)
+        return
+    console.print(f"[bold]{user['username']}[/bold]  ({user['email']})")

bitsreef_cli-0.1.0/bitsreef_cli/commands/completion.py

@@ -0,0 +1,29 @@
+"""Shell-completion command — emit a completion script for bash/zsh/fish."""
+import click
+from click.shell_completion import get_completion_class
+
+_INSTALL_HINTS = {
+    "bash": 'eval "$(bitsreef completion bash)"  # add to ~/.bashrc',
+    "zsh": 'eval "$(bitsreef completion zsh)"    # add to ~/.zshrc',
+    "fish": "bitsreef completion fish > ~/.config/fish/completions/bitsreef.fish",
+}
+
+
+@click.command()
+@click.argument("shell", type=click.Choice(["bash", "zsh", "fish"]))
+def completion(shell):
+    """Print a shell-completion script for SHELL (bash, zsh, or fish).
+
+    Enable it by sourcing the output, e.g.:
+
+        eval "$(bitsreef completion bash)"
+
+    Add that line to your shell's rc file to make it permanent.
+    """
+    from ..main import cli as root
+
+    comp_cls = get_completion_class(shell)
+    if comp_cls is None:
+        raise click.ClickException(f"Completion is not supported for {shell}.")
+    comp = comp_cls(root, {}, "bitsreef", "_BITSREEF_COMPLETE")
+    click.echo(comp.source())

bitsreef_cli-0.1.0/bitsreef_cli/commands/cron.py

@@ -0,0 +1,166 @@
+"""Cron-job commands: list, create, trigger, runs, delete."""
+import click
+from rich.console import Console
+from rich.table import Table
+
+from ..client import get_client
+from .. import context, output
+
+console = Console()
+
+
+def _service(client, service):
+    """Resolve --service (id/name) or the linked service."""
+    link = context.read_link()
+    return context.resolve_service(client, link.get("project_id"), service, link)
+
+
+def _results(resp):
+    data = resp.json()
+    return data.get("results", []) if isinstance(data, dict) else data
+
+
+def _job_id(client, service_id, value):
+    """Resolve a cron-job id from an id or a job name."""
+    if str(value).isdigit():
+        return int(value)
+    resp = client.get(f"/services/{service_id}/cron-jobs/")
+    for j in _results(resp):
+        if j.get("name") == value:
+            return j["id"]
+    raise click.ClickException(f"No cron job '{value}' on this service.")
+
+
+@click.group()
+def cron():
+    """Manage scheduled (cron) jobs for a service."""
+
+
+@cron.command("list")
+@click.option("--service", "-s", default=None, help="Service id or name (else linked)")
+def list_jobs(service):
+    """List cron jobs on a service."""
+    client = get_client()
+    service_id = _service(client, service)
+    resp = client.get(f"/services/{service_id}/cron-jobs/")
+    if resp.status_code != 200:
+        console.print(f"[red]Failed to fetch cron jobs: {resp.text}[/red]")
+        raise SystemExit(1)
+
+    results = _results(resp)
+    if output.json_enabled():
+        output.emit(results)
+        return
+    if not results:
+        console.print("[dim]No cron jobs.[/dim]")
+        return
+
+    table = Table(title="Cron Jobs")
+    table.add_column("ID", style="dim")
+    table.add_column("Name", style="bold")
+    table.add_column("Schedule")
+    table.add_column("Enabled")
+    table.add_column("Last run")
+    table.add_column("Next run")
+    for j in results:
+        enabled = "[green]yes[/green]" if j.get("enabled") else "[red]no[/red]"
+        status = j.get("last_run_status")
+        last = (j.get("last_run") or "—")[:19]
+        if status:
+            last = f"{last} ({status})"
+        table.add_row(
+            str(j["id"]), j["name"], j.get("schedule", "—"),
+            enabled, last, (j.get("next_run") or "—")[:19],
+        )
+    console.print(table)
+
+
+@cron.command("create")
+@click.argument("name")
+@click.option("--schedule", required=True, help="Cron expression, e.g. '0 * * * *'")
+@click.option("--command", required=True, help="Command to run inside the container")
+@click.option("--service", "-s", default=None, help="Service id or name (else linked)")
+@click.option("--disabled", is_flag=True, help="Create the job disabled")
+def create_job(name, schedule, command, service, disabled):
+    """Create a cron job on a service."""
+    client = get_client()
+    service_id = _service(client, service)
+    payload = {
+        "name": name, "schedule": schedule,
+        "command": command, "enabled": not disabled,
+    }
+    resp = client.post(f"/services/{service_id}/cron-jobs/", json=payload)
+    if resp.status_code == 201:
+        j = resp.json()
+        console.print(f"[green]Created[/green] [bold]{j['name']}[/bold] (id={j['id']})  next={j.get('next_run') or '—'}")
+    else:
+        console.print(f"[red]Failed: {resp.text}[/red]")
+
+
+@cron.command("trigger")
+@click.argument("job")
+@click.option("--service", "-s", default=None, help="Service id or name (else linked)")
+def trigger_job(job, service):
+    """Run a cron job now (by name or id)."""
+    client = get_client()
+    service_id = _service(client, service)
+    job_id = _job_id(client, service_id, job)
+    resp = client.post(f"/services/{service_id}/cron-jobs/{job_id}/trigger/")
+    if resp.status_code == 202:
+        console.print("[green]Triggered.[/green]")
+    else:
+        console.print(f"[red]Failed: {resp.text}[/red]")
+
+
+@cron.command("runs")
+@click.argument("job")
+@click.option("--service", "-s", default=None, help="Service id or name (else linked)")
+def job_runs(job, service):
+    """Show recent run history for a cron job (by name or id)."""
+    client = get_client()
+    service_id = _service(client, service)
+    job_id = _job_id(client, service_id, job)
+    resp = client.get(f"/services/{service_id}/cron-jobs/{job_id}/runs/")
+    if resp.status_code != 200:
+        console.print(f"[red]Failed to fetch runs: {resp.text}[/red]")
+        raise SystemExit(1)
+
+    results = _results(resp)
+    if output.json_enabled():
+        output.emit(results)
+        return
+    if not results:
+        console.print("[dim]No runs yet.[/dim]")
+        return
+
+    table = Table(title="Cron Runs")
+    table.add_column("ID", style="dim")
+    table.add_column("Status")
+    table.add_column("Exit")
+    table.add_column("Started")
+    table.add_column("Completed")
+    for r in results:
+        s = r.get("status", "")
+        color = "green" if s == "success" else "red" if s == "failed" else "yellow"
+        table.add_row(
+            str(r["id"]), f"[{color}]{s}[/{color}]",
+            str(r.get("exit_code") if r.get("exit_code") is not None else "—"),
+            (r.get("started_at") or "—")[:19], (r.get("completed_at") or "—")[:19],
+        )
+    console.print(table)
+
+
+@cron.command("delete")
+@click.argument("job")
+@click.option("--service", "-s", default=None, help="Service id or name (else linked)")
+@click.confirmation_option(prompt="Delete this cron job?")
+def delete_job(job, service):
+    """Delete a cron job (by name or id)."""
+    client = get_client()
+    service_id = _service(client, service)
+    job_id = _job_id(client, service_id, job)
+    resp = client.delete(f"/services/{service_id}/cron-jobs/{job_id}/")
+    if resp.status_code == 204:
+        console.print("[green]Deleted.[/green]")
+    else:
+        console.print(f"[red]Failed: {resp.text}[/red]")