bitsreef-cli 0.1.0__py3-none-any.whl

bitsreef_cli/shell.py

@@ -0,0 +1,136 @@
+"""Interactive shell over WebSocket (`bitsreef exec`).
+
+Bridges the local terminal to the platform's WebShellConsumer
+(`/ws/services/{id}/shell/?token=<JWT>`) — a Docker exec of `/bin/sh` with a
+TTY. JSON frames:
+  server → {"type":"connected"} | {"type":"output","data":..} | {"type":"ping"}
+  client → {"type":"input","data":..} | {"type":"pong"} | {"type":"resize",...}
+
+POSIX only (needs termios); requires an interactive TTY. Input is decoded as
+UTF-8 to match the web terminal (the consumer re-encodes it UTF-8 before writing
+to the container socket).
+"""
+import json
+import os
+import select
+import sys
+from urllib.parse import urlsplit, urlunsplit
+
+from rich.console import Console
+
+console = Console()
+
+# Close codes the consumer uses → human hints.
+_CLOSE_HINTS = {
+    4001: "not authenticated (log in again)",
+    4003: "permission denied (viewer role can't open a shell)",
+    4004: "no running container for this service (is it deployed and running?)",
+}
+
+
+def shell_ws_url(api_url: str, service_id) -> str:
+    """Derive wss://host/ws/services/{id}/shell/ from the REST base URL."""
+    parts = urlsplit(api_url)
+    scheme = "wss" if parts.scheme == "https" else "ws"
+    return urlunsplit((scheme, parts.netloc, f"/ws/services/{service_id}/shell/", "", ""))
+
+
+def _term_size() -> tuple[int, int]:
+    try:
+        size = os.get_terminal_size()
+        return size.columns, size.lines
+    except OSError:
+        return 80, 24
+
+
+def exec_shell(api_url: str, token: str | None, service_id) -> int:
+    """Open an interactive shell to the service. Returns a process exit code."""
+    try:
+        import websocket  # from websocket-client
+    except ImportError:
+        console.print("[red]exec needs 'websocket-client'. Install: pip install websocket-client[/red]")
+        return 1
+    if not token:
+        console.print("[red]Not logged in. Run: bitsreef auth login[/red]")
+        return 1
+    if not sys.stdin.isatty():
+        console.print("[red]exec requires an interactive terminal (a TTY).[/red]")
+        return 1
+    try:
+        import termios
+        import tty
+    except ImportError:
+        console.print("[red]exec is only supported on POSIX terminals.[/red]")
+        return 1
+
+    url = f"{shell_ws_url(api_url, service_id)}?token={token}"
+    try:
+        ws = websocket.create_connection(url, timeout=30)
+    except Exception as exc:  # noqa: BLE001
+        console.print(f"[red]Could not open shell: {exc}[/red]")
+        return 1
+
+    stdin_fd = sys.stdin.fileno()
+    old_attr = termios.tcgetattr(stdin_fd)
+    connected = False
+    last_size = None
+    try:
+        tty.setraw(stdin_fd)
+        while True:
+            size = _term_size()
+            if size != last_size:
+                ws.send(json.dumps({"type": "resize", "cols": size[0], "rows": size[1]}))
+                last_size = size
+
+            try:
+                readable, _, _ = select.select([stdin_fd, ws.sock], [], [], 0.5)
+            except (OSError, select.error):
+                continue
+
+            if ws.sock in readable:
+                try:
+                    raw = ws.recv()
+                except websocket.WebSocketTimeoutException:
+                    raw = None
+                except websocket.WebSocketConnectionClosedException:
+                    break
+                if raw == "":
+                    break
+                if raw:
+                    msg = _parse(raw)
+                    kind = msg.get("type")
+                    if kind == "output":
+                        os.write(1, msg.get("data", "").encode("utf-8", errors="replace"))
+                    elif kind == "ping":
+                        ws.send(json.dumps({"type": "pong"}))
+                    elif kind == "connected":
+                        connected = True
+
+            if stdin_fd in readable:
+                data = os.read(stdin_fd, 4096)
+                if not data:
+                    break
+                ws.send(json.dumps({"type": "input", "data": data.decode("utf-8", errors="replace")}))
+    except KeyboardInterrupt:
+        pass
+    finally:
+        termios.tcsetattr(stdin_fd, termios.TCSADRAIN, old_attr)
+        code = getattr(ws, "close_code", None)
+        try:
+            ws.close()
+        except Exception:  # noqa: BLE001
+            pass
+        os.write(1, b"\r\n")
+        if not connected:
+            hint = _CLOSE_HINTS.get(code)
+            console.print(f"[red]Shell closed before it was ready"
+                          + (f": {hint}" if hint else ".") + "[/red]")
+            return 1
+    return 0
+
+
+def _parse(raw):
+    try:
+        return json.loads(raw)
+    except (json.JSONDecodeError, ValueError):
+        return {}

bitsreef_cli-0.1.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,33 @@
+bitsreef_cli/__init__.py,sha256=d2rIHTuw6oOKeM_JGJaLc0FNByocLtqyoKUx2A_aUWE,100
+bitsreef_cli/client.py,sha256=lqxnDOEk18f6hdoISRHjfhRfm2gkTOJ7HwktbkdxdYU,2580
+bitsreef_cli/config.py,sha256=tkZXf8DvDJpO5257KG2Q5J6RN6dadT2Zsx2kcKT3yTY,2714
+bitsreef_cli/context.py,sha256=29emi67dm6Gr7tHtISbzB-RUWuSV1oW4Hi76siYIJ4o,6325
+bitsreef_cli/deploy_watch.py,sha256=KSGzT4V8wsPfeLV5nZPHtGytutYqz-3fATHf_eECU0Q,2813
+bitsreef_cli/log_stream.py,sha256=7axF9RfouVa9Q61GZ6KdUw8VBbXVK1TKsLgE5hfWTLE,2811
+bitsreef_cli/main.py,sha256=787tz6szHDhab2VbDDjVG8QNXHLDOph17vBVL9tIn6c,1285
+bitsreef_cli/output.py,sha256=xtKDbHyH9Rif-eodV2LwZwyHjB6Rr0oWQWZxtsVKbBs,645
+bitsreef_cli/shell.py,sha256=IEED9kVHmmtBrc7Zggx0pnaGc7NyfOWK_AaofrSND9A,4675
+bitsreef_cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bitsreef_cli/commands/auth.py,sha256=sssQPWgS-IOfcjhNlcqc572uRLmxjfq0esgTk-MzjnI,2667
+bitsreef_cli/commands/completion.py,sha256=xJksAHO0eP3KhPchaO2IB_4d8-uTiDWK1fBuFIWYjKU,1014
+bitsreef_cli/commands/cron.py,sha256=aXsvIbr4poyB4HtoX8FNMW-BdasJvAqmQs3Z0kQhma8,5843
+bitsreef_cli/commands/deploy.py,sha256=_MRLwd9uHc3A4C0JfUL5-Uv2ZVBUYcKg2JlamCXQg34,4747
+bitsreef_cli/commands/domains.py,sha256=Gvw5gsKY_ekR-pgkG6H_FRvo97jwwdQ9ohpOREpqno8,4285
+bitsreef_cli/commands/env.py,sha256=vPEh3KUOrjoIUSIYZduEbYhMcHyLQqG6BZvboBnbvnc,4599
+bitsreef_cli/commands/environments.py,sha256=1OAhNaiK-hV8-dsxvLyRlmzrjnAZPDUTSIv05-96ChM,4869
+bitsreef_cli/commands/exec_cmd.py,sha256=W8QKp5uFXBP8uAajQYxS4NZf0loSJ5o54qYtNbxs05w,961
+bitsreef_cli/commands/functions.py,sha256=JbDGyG8sfzL6w4ZOpaa93yH5sypqV3r2w1sTuah3Cks,6737
+bitsreef_cli/commands/link.py,sha256=Kk6A-WZcPfc176cmFeKAW27zx-rv7scl01Cx_GBcaag,3470
+bitsreef_cli/commands/logs.py,sha256=6chUbddpPxWq1ZoS9VvwS7-Q3RjtyR8udURMMD8dj1s,1539
+bitsreef_cli/commands/metrics.py,sha256=SafT0PywElDI4S36Pn7iff6S9cAXURYofsxMehmCzHA,1806
+bitsreef_cli/commands/projects.py,sha256=lK5BnfytgFvvnXPE6SHpXVBP-TNEvAlhwE4CG_EUnnQ,3279
+bitsreef_cli/commands/services.py,sha256=FftblzAKZOCtVGVduMvsz1aJ2qWGRCN9wg9_BOvBfnE,6125
+bitsreef_cli/commands/templates.py,sha256=ehvVb8l-pmAFxXpR-gfUaO3ht2hZF1iQCKnfYJnFXrM,3480
+bitsreef_cli/commands/up.py,sha256=gmlRjHPmS9QczphT2huoT18XE9xD0GM3BosucejUL2M,8026
+bitsreef_cli/commands/volumes.py,sha256=DIg9GnoIUqaDYJErLCwvkOij03Qml8AvCt5FdBNleEA,3659
+bitsreef_cli/commands/webhooks.py,sha256=kSj3Ms9EcB_-InRWZGChATHmGphxK_Rcay6h0zJ9lyY,4405
+bitsreef_cli-0.1.0.dist-info/METADATA,sha256=gAjyC8uqShQowGjgHzGHPX6EQ02ZGnZ1gWHw8g1Oj6Q,5164
+bitsreef_cli-0.1.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+bitsreef_cli-0.1.0.dist-info/entry_points.txt,sha256=twdWn6DTBFt1Ja86AlULQIZrMtLOx9bIkzb8DuyGajU,51
+bitsreef_cli-0.1.0.dist-info/top_level.txt,sha256=33vyz1VgWvyPRiVCMpq0tOepMtH5JdDrgatSKVE0P4Q,13
+bitsreef_cli-0.1.0.dist-info/RECORD,,

bitsreef_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

bitsreef_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+bitsreef = bitsreef_cli.main:cli

bitsreef_cli-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+bitsreef_cli