superwise-sentinel-cli 0.1.0__tar.gz

superwise_sentinel_cli-0.1.0/.claude/settings.local.json

@@ -0,0 +1,7 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(curl -s \"https://raw.githubusercontent.com/google/generative-ai-python/main/google/generativeai/client.py\")"
+    ]
+  }
+}

superwise_sentinel_cli-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+__pycache__/
+*.py[cod]
+.venv/
+dist/
+*.egg-info/
+.idea/

superwise_sentinel_cli-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,107 @@
+##################################
+# Variables
+##################################
+variables:
+  API_GW_URL: "https://api-staging.staging.superwise.ai"
+  JOB_TAG: f0nl9KXRnY9vZaSJuQd2iigwi4nhFk
+  OPENAPI_FILE: openapi.json
+  PACKAGE_NAME: superwise_sentinel_cli
+  PYTHON_VERSION: "3.11"
+
+##################################
+# Workflow
+##################################
+workflow:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS && $CI_PIPELINE_SOURCE == "push"
+      when: never
+    - if: $CI_COMMIT_BRANCH
+
+##################################
+# Stages
+##################################
+stages:
+  - test
+  - code-review
+  - pre-commit
+  - build
+  - publish
+  - release
+
+##################################
+# Templates
+##################################
+include:
+  - project: "askboss/product/superwise/ci-templates"
+    file: "sw2/stages/test.gitlab-ci.yml"
+  - project: "askboss/product/superwise/ci-templates"
+    file: "sw2/stages/code-review.gitlab-ci.yml"
+  - project: "askboss/product/superwise/ci-templates"
+    file: "sw2/templates/publish-package.gitlab-ci.yml"
+  - project: "askboss/product/superwise/ci-templates"
+    file: "sw2/stages/release.gitlab-ci.yml"
+  - project: "askboss/product/superwise/ci-templates"
+    file: "sw2/stages/post-python.gitlab-ci.yml"
+  - project: "askboss/product/superwise/ci-templates"
+    file: "sw2/templates/post.gitlab-ci.yml"
+
+##################################
+# Jobs
+##################################
+pytest:
+  cache:
+    paths:
+      - .venv/
+      - $PRE_COMMIT_HOME
+      - $XDG_CACHE_HOME
+  rules:
+    - if: $CI_PIPELINE_SOURCE != "web"
+
+pre-commit:
+  stage: pre-commit
+  rules:
+    - if: $CI_PIPELINE_SOURCE != "web"
+
+publish-testpypi:
+  stage: publish
+  image:
+    name: $SUPERWISE_STAGE_BASE_IMAGE
+  rules:
+    - if: $CI_COMMIT_BRANCH == "master"
+  cache:
+    key: $CI_JOB_NAME
+    policy: pull-push
+    paths:
+      - .venv/
+      - $XDG_CACHE_HOME
+  needs:
+    - job: pytest
+      optional: true
+  script:
+    - export VERSION="$(date +%Y%m%d%H%M%S)-dev"
+    - pyenv local ${PYTHON_VERSION}
+    - poetry version $VERSION
+    - poetry config repositories.test-pypi $POETRY_REPOSITORIES_TESTPYPI_URL
+    - poetry publish -r test-pypi --build -u $POETRY_HTTP_BASIC_TESTPYPI_USERNAME -p $POETRY_HTTP_BASIC_TESTPYPI_PASSWORD
+  tags:
+    - $JOB_TAG
+
+publish-internal-testpypi:
+  extends: .poetry-publish
+  variables:
+    POETRY_PUBLISH_REPOSITORY: testpypi
+    POETRY_PUBLISH_VERSION: ${CI_PIPELINE_ID}.dev0
+    POETRY_PUBLISH_USERNAME: $GOOGLE_ARTIFACT_REGISTRY_TESTPYPI_USER
+    POETRY_PUBLISH_PASSWORD: $GOOGLE_ARTIFACT_REGISTRY_TESTPYPI_PASSWORD
+    POETRY_PUBLISH_REPOSITORY_URL: $GOOGLE_ARTIFACT_REGISTRY_TESTPYPI_URL
+
+release:
+  needs:
+    - publish-testpypi
+  rules:
+    - if: $CI_COMMIT_BRANCH == "master" && $CI_PIPELINE_SOURCE == "web"
+  when: manual
+
+check-conventional-commits:
+  extends: .check-conventional-commits

superwise_sentinel_cli-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-xml
+      - id: pretty-format-json
+        args: [ --autofix ]
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+      - id: black
+        args: [ --line-length=120 ]
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.10.0
+    hooks:
+      - id: reorder-python-imports
+  - repo: https://github.com/python-poetry/poetry
+    rev: 2.1.4
+    hooks:
+      - id: poetry-check
+      - id: poetry-lock
+        additional_dependencies:
+          - keyrings.google-artifactregistry-auth==1.1.2

superwise_sentinel_cli-0.1.0/CLAUDE.md

@@ -0,0 +1,65 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project overview
+
+`superwise-sentinel-cli` is a Python CLI tool (`sentinel`) that routes LLM provider traffic through a Superwise Sentinel guardrails proxy. It supports a **local** mode (starts a Docker container) and a **remote** mode (points at a configured cloud URL). The `proxy on`/`proxy off` commands persist env var assignments to a sourced shell file so that new terminals pick up the proxy configuration automatically.
+
+## Setup & development
+
+```bash
+# Install dependencies (poetry manages the .venv in-project)
+poetry install
+
+# Run the CLI during development
+poetry run sentinel --help
+
+# Build the package
+poetry run hatch build
+
+# Install pre-commit hooks
+pre-commit install
+```
+
+The `poetry.toml` pins `virtualenvs.in-project = true`, so the venv lives at `.venv/`.
+
+## Tests
+
+There is no test suite. `src/sentinel_cli/test_questionary.py` is a scratch file, not a test module.
+
+## Linting
+
+Pre-commit hooks enforce:
+- **black** at 120-character line length
+- **reorder-python-imports** for import ordering
+
+Run manually: `pre-commit run --all-files`
+
+## Architecture
+
+All source lives under `src/sentinel_cli/`:
+
+- **`cli.py`** — Click command tree: root group `main`, with subgroups `gateway` (start/stop) and `proxy` (on/off), plus top-level commands `auth` and `config`. Imports from `auth`, `runner`, `shell_profile`, and `config`.
+- **`config.py`** — `AppConfig` (pydantic-settings). Settings priority: env vars (`SENTINEL_*`) > `~/.config/sentinel/config.json` > field defaults. Also owns `_PROVIDER_CONFIG` (provider → env var + URL path mapping) and `VALID_PROVIDERS`. `AppConfig.load()` / `.save()` are the only intended access points.
+- **`auth.py`** — `authenticate()` hits the Superwise auth API and caches the token at `~/.config/sentinel/token`. Skips the network call on subsequent invocations unless `force=True`.
+- **`runner.py`** — `get_or_create_local_endpoint()` starts the Docker container and returns its base URL. `resolve_env_vars()` maps provider names to `(env_var, full_url)` pairs using `_PROVIDER_CONFIG` from `config.py`.
+- **`docker_manager.py`** — Manages the `sentinel-local` Docker container (image: `us-central1-docker.pkg.dev/admina33d6818/docker/platform/sentinel:<tag>`). `ensure_container_running()` pulls, starts, and returns a `ContainerEndpoint`; `stop_container()` stops and removes it. Falls back to `linux/amd64` when native platform image is unavailable.
+- **`shell_profile.py`** — `ShellContext` abstraction with `_UnixShellContext` (bash/zsh, auto-detected) and `_WindowsShellContext` (PowerShell). `ensure_shell_integration()` / `remove_shell_integration()` patch the shell profile. `write_env_vars()` / `remove_env_vars()` manage `~/.config/sentinel/protected_vars.json` and a sourced env file. On macOS, also calls `launchctl setenv/unsetenv` for GUI app visibility. The module-level `SHELL` constant holds the current platform context.
+
+## Config & state files
+
+| Path | Purpose |
+|---|---|
+| `~/.config/sentinel/config.json` | Persisted `AppConfig` |
+| `~/.config/sentinel/protected_vars.json` | Currently active env var→URL mappings |
+| `~/.config/sentinel/token` | Cached Superwise auth token |
+| `~/.config/sentinel/env.sh` (Unix) / `env.ps1` (Windows) | Sourced by the shell wrapper on each new session |
+
+## Key design constraint
+
+`proxy on` writes env var assignments to `~/.config/sentinel/env.sh` (or `env.ps1` on Windows), which the shell profile sources automatically on new sessions. `proxy off` deletes those files and the state JSON. On macOS, `launchctl setenv/unsetenv` is also called so GUI apps (not just terminal sessions) pick up the change immediately.
+
+Env var changes are therefore **not visible in the current shell session** — they take effect in new terminals. On macOS, GUI apps see the change immediately via launchctl.
+
+The `ensure_shell_integration()` / `remove_shell_integration()` functions in `shell_profile.py` add/remove the `source` line from the user's shell profile (`~/.zshrc` or `~/.bashrc`).

superwise_sentinel_cli-0.1.0/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: superwise-sentinel-cli
+Version: 0.1.0
+Summary: Sentinel is an LLM proxy that intercepts traffic, enabling you to monitor, secure, and optimize your AI usage. This CLI tool helps you quickly set up traffic interception on this machine
+Requires-Python: <4.0,>=3.11
+Requires-Dist: click>=8.1
+Requires-Dist: docker>=7.0
+Requires-Dist: pydantic-settings>=2.3
+Requires-Dist: pydantic>=2.0

superwise_sentinel_cli-0.1.0/README.md

@@ -0,0 +1,64 @@
+# superwise-sentinel-cli
+
+CLI for [Superwise Sentinel](https://docs.superwise.ai) — routes LLM provider traffic through an AI guardrails proxy.
+
+## Installation
+
+```bash
+pip install superwise-sentinel-cli
+```
+
+## Quick start
+
+```bash
+sentinel quickstart
+```
+
+The interactive wizard walks you through authentication, starting a local gateway container, and activating proxy interception. Open a new terminal after setup for env vars to take effect.
+
+## Commands
+
+### `sentinel auth`
+
+Authenticate with Superwise (prompts for Client ID and Client Secret). Pass `--advanced` to override the auth/API host URLs.
+
+### `sentinel gateway`
+
+| Command | Description |
+|---|---|
+| `sentinel gateway start` | Pull and start the local Docker gateway container |
+| `sentinel gateway stop` | Stop and remove the container |
+
+Pass `--sentinel-id <uuid>` to `start` to use an existing sentinel rather than creating a new one.
+
+### `sentinel config`
+
+Configure the gateway URL and which LLM providers to intercept. Valid providers: `anthropic`, `openai`, `google`. Use `all` to select every provider.
+
+### `sentinel proxy`
+
+| Command | Description |
+|---|---|
+| `sentinel proxy on` | Write proxy env vars; takes effect in new shell sessions |
+| `sentinel proxy off` | Remove proxy env vars |
+
+`proxy on` persists env var assignments to `~/.config/sentinel/env.sh`, which your shell profile sources on startup. On macOS, `launchctl setenv` is also called so GUI apps pick up the change immediately. Changes are **not** visible in the current terminal — open a new one.
+
+## Configuration
+
+Config is stored at `~/.config/sentinel/config.json` and can be overridden with `SENTINEL_*` environment variables.
+
+| Setting | Env var | Description |
+|---|---|---|
+| `gateway_url` | `SENTINEL_GATEWAY_URL` | Gateway endpoint URL |
+| `providers` | `SENTINEL_PROVIDERS` | Providers to intercept (`anthropic`, `openai`, `google`) |
+| `superwise_client_id` | `SENTINEL_SUPERWISE_CLIENT_ID` | Superwise client ID |
+| `superwise_client_secret` | `SENTINEL_SUPERWISE_CLIENT_SECRET` | Superwise client secret |
+| `sentinel_id` | `SENTINEL_SENTINEL_ID` | Sentinel ID |
+
+Credentials can be generated at [https://docs.superwise.ai/docs/generate-tokens](https://docs.superwise.ai/docs/generate-tokens).
+
+## Requirements
+
+- Python 3.11+
+- Docker (local gateway mode only)