orchestra-cli 0.1.3__tar.gz → 0.3.0__tar.gz

{orchestra_cli-0.1.3 → orchestra_cli-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orchestra-cli
-Version: 0.1.3
+Version: 0.3.0
 Summary: Orchestra CLI. Perform operations with Orchestra locally.
 Author-email: Orchestra Technologies <support@getorchestra.io>
 Requires-Python: >=3.10
@@ -15,6 +15,8 @@ Orchestra CLI for working with Orchestra pipelines from your terminal.
 
 Two entrypoints are available: `orchestra` and `orchestra-cli` (they are equivalent).
 
+See [`AGENTS.md`](AGENTS.md) for contributor and AI agent guidance (environment setup, code conventions, testing).
+
 ## Installation
 
 ```bash
@@ -29,14 +31,17 @@ pipx install orchestra-cli
 
 ## Environment variables
 
-- `ORCHESTRA_API_KEY`: Required for actions that call the API (`import`, `run`).
-- `BASE_URL`: Optional. Override the default API base
-  (`https://app.getorchestra.io/api/engine/public/pipelines/{}`) for non‑production/testing.
+- `ORCHESTRA_API_KEY`: Required for actions that call the API (`import`, `create-pipeline`, `update-pipeline`, `delete-pipeline`, `run`).
+- `BASE_URL`: Optional. Override the default Orchestra host (`https://app.getorchestra.io`) for non‑production/testing.
 
 ## Commands overview
 
 - `validate`: Validate a pipeline YAML locally against the Orchestra API schema.
 - `import`: Register a pipeline YAML (from a git repo) with Orchestra under an alias.
+- `fetch-pipelines`: Fetch the pipelines visible to the current API key as JSON.
+- `create-pipeline`: Create an Orchestra-backed pipeline from a local YAML file.
+- `update-pipeline`: Update an existing Orchestra-backed pipeline from a local YAML file.
+- `delete-pipeline`: Delete an existing pipeline by alias.
 - `run`: Start a pipeline run by alias, optionally pinning branch/commit and waiting for completion.
 
 Use `orchestra --help` or `orchestra <command> --help` for built-in help.
@@ -118,6 +123,104 @@ Common errors
 
 ---
 
+## create-pipeline
+
+Create an Orchestra-backed pipeline directly from a local YAML file.
+
+```bash
+export ORCHESTRA_API_KEY=...
+
+orchestra create-pipeline \
+  --alias my-pipeline \
+  --path ./pipelines/pipeline.yaml \
+  --publish            # optional, defaults to --no-publish
+```
+
+Options
+
+- `-a, --alias` (required): Pipeline alias.
+- `-p, --path` (required): Path to pipeline YAML file.
+- `--publish/--no-publish` (optional, default `--no-publish`): Whether the pipeline is published.
+
+Behavior
+
+- Validates YAML against the Orchestra schema endpoint before creating.
+- Sends pipeline data to `POST /pipelines` with `storage_provider=ORCHESTRA`.
+- On success, prints the pipeline edit URL (`/pipelines/{pipeline_id}/edit`) when an ID is returned.
+- Exit codes: `0` on success, `1` on failure.
+
+---
+
+## fetch-pipelines
+
+Fetch the pipelines available to the current Orchestra API key.
+
+```bash
+export ORCHESTRA_API_KEY=...
+
+orchestra fetch-pipelines
+```
+
+Behavior
+
+- Sends `GET /api/engine/public/pipelines`. Responses always include each pipeline's latest run metadata.
+- Prints the response payload as pretty JSON for scripting and inspection.
+- Exit codes: `0` on success, `1` on failure.
+
+---
+
+## update-pipeline
+
+Update an existing Orchestra-backed pipeline from a local YAML file.
+
+```bash
+export ORCHESTRA_API_KEY=...
+
+orchestra update-pipeline \
+  --alias my-pipeline \
+  --path ./pipelines/pipeline.yaml \
+  --no-publish         # default
+```
+
+Options
+
+- `-a, --alias` (required): Pipeline alias to update.
+- `-p, --path` (required): Path to pipeline YAML file.
+- `--publish/--no-publish` (optional, default `--no-publish`): Whether the pipeline is published.
+
+Behavior
+
+- Validates YAML against the Orchestra schema endpoint before updating.
+- Sends pipeline data to `PUT /pipelines/{alias}` with `storage_provider=ORCHESTRA`.
+- Only Orchestra-backed pipelines can be updated via this endpoint (Git-backed pipelines are rejected).
+- On success, prints the pipeline edit URL (`/pipelines/{pipeline_id}/edit`) when an ID is returned.
+- Exit codes: `0` on success, `1` on failure.
+
+---
+
+## delete-pipeline
+
+Delete a pipeline by alias.
+
+```bash
+export ORCHESTRA_API_KEY=...
+
+orchestra delete-pipeline --alias my-pipeline
+```
+
+Options
+
+- `-a, --alias` (required): Pipeline alias to delete.
+
+Behavior
+
+- Sends `DELETE /pipelines/{alias}` with API key authentication.
+- Deletes the pipeline resolved by alias within the authenticated account.
+- On success, exits with code `0` after printing a confirmation message.
+- Exit codes: `0` on success, `1` on failure.
+
+---
+
 ## run
 
 Start a pipeline run by alias. Optionally specify a branch and/or commit. By default, the command waits and polls the run status until completion.

{orchestra_cli-0.1.3 → orchestra_cli-0.3.0}/README.md

@@ -4,6 +4,8 @@ Orchestra CLI for working with Orchestra pipelines from your terminal.
 
 Two entrypoints are available: `orchestra` and `orchestra-cli` (they are equivalent).
 
+See [`AGENTS.md`](AGENTS.md) for contributor and AI agent guidance (environment setup, code conventions, testing).
+
 ## Installation
 
 ```bash
@@ -18,14 +20,17 @@ pipx install orchestra-cli
 
 ## Environment variables
 
-- `ORCHESTRA_API_KEY`: Required for actions that call the API (`import`, `run`).
-- `BASE_URL`: Optional. Override the default API base
-  (`https://app.getorchestra.io/api/engine/public/pipelines/{}`) for non‑production/testing.
+- `ORCHESTRA_API_KEY`: Required for actions that call the API (`import`, `create-pipeline`, `update-pipeline`, `delete-pipeline`, `run`).
+- `BASE_URL`: Optional. Override the default Orchestra host (`https://app.getorchestra.io`) for non‑production/testing.
 
 ## Commands overview
 
 - `validate`: Validate a pipeline YAML locally against the Orchestra API schema.
 - `import`: Register a pipeline YAML (from a git repo) with Orchestra under an alias.
+- `fetch-pipelines`: Fetch the pipelines visible to the current API key as JSON.
+- `create-pipeline`: Create an Orchestra-backed pipeline from a local YAML file.
+- `update-pipeline`: Update an existing Orchestra-backed pipeline from a local YAML file.
+- `delete-pipeline`: Delete an existing pipeline by alias.
 - `run`: Start a pipeline run by alias, optionally pinning branch/commit and waiting for completion.
 
 Use `orchestra --help` or `orchestra <command> --help` for built-in help.
@@ -107,6 +112,104 @@ Common errors
 
 ---
 
+## create-pipeline
+
+Create an Orchestra-backed pipeline directly from a local YAML file.
+
+```bash
+export ORCHESTRA_API_KEY=...
+
+orchestra create-pipeline \
+  --alias my-pipeline \
+  --path ./pipelines/pipeline.yaml \
+  --publish            # optional, defaults to --no-publish
+```
+
+Options
+
+- `-a, --alias` (required): Pipeline alias.
+- `-p, --path` (required): Path to pipeline YAML file.
+- `--publish/--no-publish` (optional, default `--no-publish`): Whether the pipeline is published.
+
+Behavior
+
+- Validates YAML against the Orchestra schema endpoint before creating.
+- Sends pipeline data to `POST /pipelines` with `storage_provider=ORCHESTRA`.
+- On success, prints the pipeline edit URL (`/pipelines/{pipeline_id}/edit`) when an ID is returned.
+- Exit codes: `0` on success, `1` on failure.
+
+---
+
+## fetch-pipelines
+
+Fetch the pipelines available to the current Orchestra API key.
+
+```bash
+export ORCHESTRA_API_KEY=...
+
+orchestra fetch-pipelines
+```
+
+Behavior
+
+- Sends `GET /api/engine/public/pipelines`. Responses always include each pipeline's latest run metadata.
+- Prints the response payload as pretty JSON for scripting and inspection.
+- Exit codes: `0` on success, `1` on failure.
+
+---
+
+## update-pipeline
+
+Update an existing Orchestra-backed pipeline from a local YAML file.
+
+```bash
+export ORCHESTRA_API_KEY=...
+
+orchestra update-pipeline \
+  --alias my-pipeline \
+  --path ./pipelines/pipeline.yaml \
+  --no-publish         # default
+```
+
+Options
+
+- `-a, --alias` (required): Pipeline alias to update.
+- `-p, --path` (required): Path to pipeline YAML file.
+- `--publish/--no-publish` (optional, default `--no-publish`): Whether the pipeline is published.
+
+Behavior
+
+- Validates YAML against the Orchestra schema endpoint before updating.
+- Sends pipeline data to `PUT /pipelines/{alias}` with `storage_provider=ORCHESTRA`.
+- Only Orchestra-backed pipelines can be updated via this endpoint (Git-backed pipelines are rejected).
+- On success, prints the pipeline edit URL (`/pipelines/{pipeline_id}/edit`) when an ID is returned.
+- Exit codes: `0` on success, `1` on failure.
+
+---
+
+## delete-pipeline
+
+Delete a pipeline by alias.
+
+```bash
+export ORCHESTRA_API_KEY=...
+
+orchestra delete-pipeline --alias my-pipeline
+```
+
+Options
+
+- `-a, --alias` (required): Pipeline alias to delete.
+
+Behavior
+
+- Sends `DELETE /pipelines/{alias}` with API key authentication.
+- Deletes the pipeline resolved by alias within the authenticated account.
+- On success, exits with code `0` after printing a confirmation message.
+- Exit codes: `0` on success, `1` on failure.
+
+---
+
 ## run
 
 Start a pipeline run by alias. Optionally specify a branch and/or commit. By default, the command waits and polls the run status until completion.

orchestra_cli-0.3.0/orchestra_cli/src/cli.py

@@ -0,0 +1,20 @@
+import typer
+
+from .create_pipeline import create_pipeline
+from .delete_pipeline import delete_pipeline
+from .fetch_pipelines import fetch_pipelines
+from .import_pipeline import import_pipeline
+from .run_pipeline import run_pipeline
+from .update_pipeline import update_pipeline
+from .validate_pipeline import validate
+
+app = typer.Typer(help="Orchestra CLI – perform operations with Orchestra locally.")
+
+
+app.command(name="validate")(validate)
+app.command(name="import")(import_pipeline)
+app.command(name="run")(run_pipeline)
+app.command(name="fetch-pipelines")(fetch_pipelines)
+app.command(name="create-pipeline")(create_pipeline)
+app.command(name="update-pipeline")(update_pipeline)
+app.command(name="delete-pipeline")(delete_pipeline)

orchestra_cli-0.3.0/orchestra_cli/src/create_pipeline.py

@@ -0,0 +1,65 @@
+import json
+from pathlib import Path
+
+import httpx
+import typer
+
+from ..utils.constants import get_create_pipeline_url
+from ..utils.styling import indent_message, red, yellow
+from .pipeline_upsert import (
+    build_upsert_payload,
+    emit_success_with_edit_url,
+    load_validated_pipeline_data,
+    require_api_key,
+    require_pipeline_id_from_success_response,
+)
+
+
+def create_pipeline(
+    alias: str = typer.Option(..., "--alias", "-a", help="Pipeline alias"),
+    path: Path = typer.Option(
+        ...,
+        "--path",
+        "-p",
+        exists=True,
+        file_okay=True,
+        dir_okay=False,
+        readable=True,
+        resolve_path=True,
+        help="Path to pipeline YAML",
+    ),
+    publish: bool = typer.Option(
+        False,
+        "--publish/--no-publish",
+        help="Whether the pipeline is published and can be triggered",
+    ),
+):
+    """
+    Create an Orchestra-backed pipeline from a local YAML file.
+    """
+    api_key = require_api_key()
+    data = load_validated_pipeline_data(path)
+    payload = build_upsert_payload(data, publish, alias=alias)
+
+    try:
+        response = httpx.post(
+            get_create_pipeline_url(),
+            json=payload,
+            timeout=30,
+            headers={"Authorization": f"Bearer {api_key}"},
+        )
+    except Exception as e:
+        typer.echo(red(f"HTTP request failed: {e}"))
+        raise typer.Exit(code=1)
+
+    if response.status_code == 201:
+        pipeline_id = require_pipeline_id_from_success_response(response, "Create")
+        emit_success_with_edit_url(alias, "created", pipeline_id)
+        raise typer.Exit(code=0)
+
+    typer.echo(red(f"❌ Create failed with status {response.status_code}"))
+    try:
+        typer.echo(yellow(indent_message(json.dumps(response.json(), indent=2))))
+    except Exception:
+        typer.echo(yellow(indent_message(response.text)))
+    raise typer.Exit(code=1)

orchestra_cli-0.3.0/orchestra_cli/src/delete_pipeline.py

@@ -0,0 +1,39 @@
+import json
+
+import httpx
+import typer
+
+from ..utils.constants import get_delete_pipeline_url
+from ..utils.styling import green, indent_message, red, yellow
+from .pipeline_upsert import require_api_key
+
+
+def delete_pipeline(
+    alias: str = typer.Option(..., "--alias", "-a", help="Pipeline alias"),
+):
+    """
+    Delete a pipeline by alias.
+    """
+    api_key = require_api_key()
+
+    try:
+        response = httpx.delete(
+            get_delete_pipeline_url(alias),
+            timeout=30,
+            headers={"Authorization": f"Bearer {api_key}"},
+        )
+    except Exception as e:
+        typer.echo(red(f"HTTP request failed: {e}"))
+        raise typer.Exit(code=1)
+
+    if response.status_code == 204:
+        typer.echo(green(f"✅ Pipeline '{alias}' deleted successfully"))
+        raise typer.Exit(code=0)
+
+    typer.echo(red(f"❌ Delete failed with status {response.status_code}"))
+    try:
+        typer.echo(yellow(indent_message(json.dumps(response.json(), indent=2))))
+    except Exception:
+        if response.text:
+            typer.echo(yellow(indent_message(response.text)))
+    raise typer.Exit(code=1)

orchestra_cli-0.3.0/orchestra_cli/src/fetch_pipelines.py

@@ -0,0 +1,45 @@
+import json
+
+import httpx
+import typer
+
+from ..utils.constants import get_api_url
+from ..utils.styling import indent_message, red, yellow
+from .pipeline_upsert import require_api_key
+
+
+def fetch_pipelines():
+    """
+    Fetch pipelines available to the current Orchestra API key.
+
+    The API always includes each pipeline's latest run metadata.
+    """
+    api_key = require_api_key()
+
+    try:
+        response = httpx.get(
+            get_api_url(""),
+            timeout=30,
+            headers={"Authorization": f"Bearer {api_key}"},
+        )
+    except Exception as e:
+        typer.echo(red(f"HTTP request failed: {e}"))
+        raise typer.Exit(code=1)
+
+    if response.status_code == 200:
+        try:
+            pipelines = response.json()
+        except Exception:
+            typer.echo(red("❌ Fetch pipelines failed: success response was not valid JSON"))
+            typer.echo(yellow(indent_message(response.text)))
+            raise typer.Exit(code=1)
+
+        typer.echo(json.dumps(pipelines, indent=2))
+        raise typer.Exit(code=0)
+
+    typer.echo(red(f"❌ Fetch pipelines failed with status {response.status_code}"))
+    try:
+        typer.echo(yellow(indent_message(json.dumps(response.json(), indent=2))))
+    except Exception:
+        typer.echo(yellow(indent_message(response.text)))
+    raise typer.Exit(code=1)

orchestra_cli-0.3.0/orchestra_cli/src/pipeline_upsert.py

@@ -0,0 +1,74 @@
+import json
+import os
+from pathlib import Path
+
+import httpx
+import typer
+
+from ..utils.constants import get_pipeline_edit_url
+from ..utils.styling import green, indent_message, red, yellow
+from .import_pipeline import _load_yaml, _validate_yaml_with_api
+
+
+def require_api_key() -> str:
+    api_key = os.getenv("ORCHESTRA_API_KEY")
+    if not api_key:
+        typer.echo(red("ORCHESTRA_API_KEY is not set"))
+        raise typer.Exit(code=1)
+    return api_key
+
+
+def load_validated_pipeline_data(path: Path) -> dict:
+    if not path.exists():
+        typer.echo(red(f"File not found: {path}"))
+        raise typer.Exit(code=1)
+
+    data, err = _load_yaml(path)
+    if err is not None:
+        typer.echo(red(f"Invalid YAML: {err}"))
+        raise typer.Exit(code=1)
+
+    ok, err_msg = _validate_yaml_with_api(data or {})
+    if not ok:
+        typer.echo(red("❌ Validation failed"))
+        if err_msg:
+            typer.echo(yellow(indent_message(err_msg)))
+        raise typer.Exit(code=1)
+
+    return data or {}
+
+
+def build_upsert_payload(data: dict, publish: bool, alias: str | None = None) -> dict:
+    payload: dict[str, object] = {
+        "data": data,
+        "published": publish,
+        "storage_provider": "ORCHESTRA",
+    }
+    if alias is not None:
+        payload["alias"] = alias
+    return payload
+
+
+def require_pipeline_id_from_success_response(
+    response: httpx.Response,
+    action: str,
+) -> str:
+    try:
+        body = response.json()
+    except Exception:
+        typer.echo(red(f"❌ {action} failed: success response was not valid JSON"))
+        typer.echo(yellow(indent_message(response.text)))
+        raise typer.Exit(code=1)
+
+    pipeline_id = body.get("id")
+    if not pipeline_id:
+        typer.echo(red(f"❌ {action} failed: success response did not include pipeline id"))
+        typer.echo(yellow(indent_message(json.dumps(body, indent=2))))
+        raise typer.Exit(code=1)
+
+    return str(pipeline_id)
+
+
+def emit_success_with_edit_url(alias: str, action: str, pipeline_id: str) -> None:
+    typer.echo(green(f"✅ Pipeline '{alias}' {action} successfully: {pipeline_id}"))
+    typer.echo(yellow(f"Edit URL: {get_pipeline_edit_url(pipeline_id)}"))

orchestra_cli-0.3.0/orchestra_cli/src/update_pipeline.py

@@ -0,0 +1,65 @@
+import json
+from pathlib import Path
+
+import httpx
+import typer
+
+from ..utils.constants import get_update_pipeline_url
+from ..utils.styling import indent_message, red, yellow
+from .pipeline_upsert import (
+    build_upsert_payload,
+    emit_success_with_edit_url,
+    load_validated_pipeline_data,
+    require_api_key,
+    require_pipeline_id_from_success_response,
+)
+
+
+def update_pipeline(
+    alias: str = typer.Option(..., "--alias", "-a", help="Pipeline alias"),
+    path: Path = typer.Option(
+        ...,
+        "--path",
+        "-p",
+        exists=True,
+        file_okay=True,
+        dir_okay=False,
+        readable=True,
+        resolve_path=True,
+        help="Path to pipeline YAML",
+    ),
+    publish: bool = typer.Option(
+        False,
+        "--publish/--no-publish",
+        help="Whether the pipeline is published and can be triggered",
+    ),
+):
+    """
+    Update an Orchestra-backed pipeline from a local YAML file.
+    """
+    api_key = require_api_key()
+    data = load_validated_pipeline_data(path)
+    payload = build_upsert_payload(data, publish)
+
+    try:
+        response = httpx.put(
+            get_update_pipeline_url(alias),
+            json=payload,
+            timeout=30,
+            headers={"Authorization": f"Bearer {api_key}"},
+        )
+    except Exception as e:
+        typer.echo(red(f"HTTP request failed: {e}"))
+        raise typer.Exit(code=1)
+
+    if response.status_code == 200:
+        pipeline_id = require_pipeline_id_from_success_response(response, "Update")
+        emit_success_with_edit_url(alias, "updated", pipeline_id)
+        raise typer.Exit(code=0)
+
+    typer.echo(red(f"❌ Update failed with status {response.status_code}"))
+    try:
+        typer.echo(yellow(indent_message(json.dumps(response.json(), indent=2))))
+    except Exception:
+        typer.echo(yellow(indent_message(response.text)))
+    raise typer.Exit(code=1)

{orchestra_cli-0.1.3 → orchestra_cli-0.3.0}/orchestra_cli/tests/test_cli.py

@@ -10,3 +10,7 @@ def test_help():
     assert result.exit_code == 0
     assert "Orchestra CLI" in result.output
     assert "validate" in result.output
+    assert "fetch-pipelines" in result.output
+    assert "create-pipeline" in result.output
+    assert "delete-pipeline" in result.output
+    assert "update-pipeline" in result.output