systemlink-cli 1.3.1__py3-none-any.whl

slcli/function_templates.py

@@ -0,0 +1,85 @@
+"""Helpers for initializing local function templates (TypeScript / Python).
+
+This module encapsulates downloading and extracting subfolders from the
+SystemLink Enterprise examples repository, adding safety checks against
+path traversal, symlinks, and unexpected archive contents.
+"""
+
+from __future__ import annotations
+
+import io
+import sys
+import tarfile
+from pathlib import Path
+from typing import Dict
+
+import click
+import requests
+
+from .utils import ExitCodes
+
+TEMPLATE_REPO = "ni/systemlink-enterprise-examples"
+TEMPLATE_BRANCH = "function-examples"  # Treated as stable per user direction
+TEMPLATE_SUBFOLDERS: Dict[str, str] = {
+    "typescript": "function-examples/typescript-hono-function",
+    "python": "function-examples/python-http-function",
+}
+
+_DOWNLOAD_TIMEOUT_SECONDS = 60
+
+
+def download_and_extract_template(language: str, destination: Path) -> None:
+    """Download and extract the specified language template into destination.
+
+    Args:
+        language: Normalized language key ('typescript' or 'python').
+        destination: Directory to populate (must already exist).
+    """
+    if language not in TEMPLATE_SUBFOLDERS:
+        click.echo(f"✗ Unsupported template language: {language}", err=True)
+        sys.exit(ExitCodes.INVALID_INPUT)
+
+    subfolder = TEMPLATE_SUBFOLDERS[language]
+    tarball_url = f"https://codeload.github.com/{TEMPLATE_REPO}/tar.gz/{TEMPLATE_BRANCH}"
+    resp = None
+    try:
+        resp = requests.get(tarball_url, timeout=_DOWNLOAD_TIMEOUT_SECONDS)
+    except requests.RequestException as exc:  # noqa: BLE001
+        click.echo(f"✗ Network error downloading template: {exc}", err=True)
+        sys.exit(ExitCodes.NETWORK_ERROR)
+    if resp.status_code != 200:
+        click.echo(
+            f"✗ Failed to download template (HTTP {resp.status_code}) from {tarball_url}",
+            err=True,
+        )
+        sys.exit(ExitCodes.NETWORK_ERROR)
+
+    try:
+        with tarfile.open(fileobj=io.BytesIO(resp.content), mode="r:gz") as tf:  # type: ignore[arg-type]
+            for member in tf.getmembers():
+                # Skip symlinks / hard links for safety
+                if member.issym() or member.islnk():  # pragma: no cover - defensive
+                    continue
+                parts = member.name.split("/", 1)
+                if len(parts) < 2:
+                    continue
+                remainder = parts[1]
+                if not remainder.startswith(subfolder.rstrip("/")):
+                    continue
+                # Compute relative path inside desired subfolder
+                relative_path = Path(remainder).relative_to(subfolder)
+                if any(p == ".." for p in relative_path.parts):  # Path traversal guard
+                    continue
+                target_path = destination / relative_path
+                if member.isdir():
+                    target_path.mkdir(parents=True, exist_ok=True)
+                    continue
+                target_path.parent.mkdir(parents=True, exist_ok=True)
+                extracted = tf.extractfile(member)
+                if not extracted:
+                    continue
+                with open(target_path, "wb") as f_out:
+                    f_out.write(extracted.read())
+    except Exception as exc:  # noqa: BLE001
+        click.echo(f"✗ Error extracting template: {exc}", err=True)
+        sys.exit(ExitCodes.GENERAL_ERROR)

slcli/main.py

@@ -0,0 +1,406 @@
+"""slcli entry points."""
+
+import json
+from pathlib import Path
+from typing import Optional
+
+import click
+import keyring
+import questionary
+import tomllib
+
+from .asset_click import register_asset_commands
+from .comment_click import register_comment_commands
+from .completion_click import register_completion_command
+from .config_click import register_config_commands
+from .dff_click import register_dff_commands
+from .example_click import register_example_commands
+from .feed_click import register_feed_commands
+from .file_click import register_file_commands
+from .function_click import register_function_commands
+from .mcp_click import register_mcp_commands
+from .notebook_click import register_notebook_commands
+from .platform import (
+    PLATFORM_UNKNOWN,
+    get_platform_info,
+)
+from .policy_click import register_policy_commands
+from .profiles import set_profile_override
+from .routine_click import register_routine_commands
+from .skill_click import register_skill_commands
+from .ssl_trust import OS_TRUST_INJECTED, OS_TRUST_REASON
+from .system_click import register_system_commands
+from .tag_click import register_tag_commands
+from .templates_click import register_templates_commands
+from .testmonitor_click import register_testmonitor_commands
+from .user_click import register_user_commands
+from .webapp_click import register_webapp_commands
+from .workitem_click import register_workitem_commands
+from .workspace_click import register_workspace_commands
+
+
+def get_version() -> str:
+    """Get version from _version.py (built binary) or pyproject.toml (development)."""
+    try:
+        # Try to import from _version.py first (works in built binary)
+        from ._version import __version__
+
+        return __version__
+    except ImportError:
+        # Fall back to reading pyproject.toml (works in development)
+        try:
+            current_dir = Path(__file__).parent
+            pyproject_path = current_dir.parent / "pyproject.toml"
+
+            with open(pyproject_path, "rb") as f:
+                pyproject_data = tomllib.load(f)
+
+            return pyproject_data["tool"]["poetry"]["version"]
+        except Exception:
+            return "unknown"
+
+
+CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
+
+
+def get_ascii_art() -> str:
+    """Return ASCII art for SystemLink CLI."""
+    return """
+ ███████╗██╗   ██╗███████╗████████╗███████╗███╗   ███╗██╗     ██╗███╗   ██╗██╗  ██╗     ██████╗██╗     ██╗
+ ██╔════╝╚██╗ ██╔╝██╔════╝╚══██╔══╝██╔════╝████╗ ████║██║     ██║████╗  ██║██║ ██╔╝    ██╔════╝██║     ██║
+ ███████╗ ╚████╔╝ ███████╗   ██║   █████╗  ██╔████╔██║██║     ██║██╔██╗ ██║█████╔╝     ██║     ██║     ██║
+ ╚════██║  ╚██╔╝  ╚════██║   ██║   ██╔══╝  ██║╚██╔╝██║██║     ██║██║╚██╗██║██╔═██╗     ██║     ██║     ██║
+ ███████║   ██║   ███████║   ██║   ███████╗██║ ╚═╝ ██║███████╗██║██║ ╚████║██║  ██╗    ╚██████╗███████╗██║
+ ╚══════╝   ╚═╝   ╚══════╝   ╚═╝   ╚══════╝╚═╝     ╚═╝╚══════╝╚═╝╚═╝  ╚═══╝╚═╝  ╚═╝     ╚═════╝╚══════╝╚═╝
+"""
+
+
+@click.group(context_settings=CONTEXT_SETTINGS, invoke_without_command=True)
+@click.option("--version", "-v", is_flag=True, help="Show version and exit")
+@click.option(
+    "--profile",
+    "-p",
+    envvar="SLCLI_PROFILE",
+    help="Use a specific profile for this command",
+)
+@click.pass_context
+def cli(ctx: click.Context, version: bool, profile: Optional[str]) -> None:
+    """SystemLink CLI for managing SystemLink resources."""  # noqa: D403
+    if version:
+        click.echo(f"slcli version {get_version()}")
+        ctx.exit()
+
+    # Set profile override if specified (applies to all subcommands)
+    if profile:
+        set_profile_override(profile)
+
+    # Check for mandatory migration BEFORE any command runs
+    # Skip migration check only for version flag and config migrate command
+    if ctx.invoked_subcommand not in (None, "config"):
+        from .profiles import ProfileConfig, has_keyring_credentials, migrate_from_keyring
+
+        config_path = ProfileConfig.get_config_path()
+        if not config_path.exists() and has_keyring_credentials():
+            click.echo("⚠️  Migration Required")
+            click.echo("")
+            click.echo("slcli now uses profile-based configuration.")
+            click.echo("Existing keyring credentials detected and will be migrated to:")
+            click.echo(f"  {config_path}")
+            click.echo("")
+            click.echo("Migrating credentials...")
+
+            try:
+                migrated_profile = migrate_from_keyring(profile_name="default", delete_keyring=True)
+                if migrated_profile:
+                    click.echo(f"✓ Migrated credentials to profile 'default'")
+                    click.echo(f"  Server: {migrated_profile.server}")
+                    if migrated_profile.web_url:
+                        click.echo(f"  Web URL: {migrated_profile.web_url}")
+                    if migrated_profile.platform:
+                        click.echo(f"  Platform: {migrated_profile.platform}")
+                    click.echo("✓ Deleted keyring entries")
+                    click.echo("")
+                    click.echo("Migration complete! Continuing with your command...")
+                    click.echo("")
+                else:
+                    click.echo(
+                        "✗ Migration failed: No valid credentials found in keyring.", err=True
+                    )
+                    ctx.exit(1)
+            except Exception as e:
+                click.echo(f"✗ Migration failed: {e}", err=True)
+                click.echo("Run 'slcli config migrate' to try again.", err=True)
+                ctx.exit(1)
+
+    if ctx.invoked_subcommand is None:
+        click.echo(get_ascii_art())
+        click.echo(ctx.get_help())
+
+
+@cli.command(hidden=True, name="_ca-info")
+def ca_info() -> None:
+    """Show TLS CA trust source (hidden diagnostic)."""
+    if OS_TRUST_INJECTED:
+        click.echo(f"CA Source: system (reason={OS_TRUST_REASON})")
+    else:
+        # Determine if custom verify path set via env
+        import os
+
+        verify_env = os.environ.get("REQUESTS_CA_BUNDLE") or os.environ.get("SSL_CERT_FILE")
+        if verify_env:
+            click.echo(f"CA Source: custom-pem ({verify_env})")
+        else:
+            click.echo(f"CA Source: certifi (reason={OS_TRUST_REASON})")
+
+
+@cli.command()
+@click.option("--profile", "-p", help="Profile name (default: 'default')")
+@click.option("--url", help="SystemLink API URL")
+@click.option("--api-key", help="SystemLink API key")
+@click.option("--web-url", help="SystemLink Web UI base URL")
+@click.option("--workspace", "-w", help="Default workspace for this profile")
+@click.option(
+    "--set-current/--no-set-current",
+    default=True,
+    help="Set as current profile (default: yes)",
+)
+@click.option(
+    "--readonly",
+    is_flag=True,
+    help=(
+        "Enable readonly mode (disables create, update, delete, import, upload, "
+        "publish, and disable commands)"
+    ),
+)
+def login(
+    profile: Optional[str],
+    url: Optional[str],
+    api_key: Optional[str],
+    web_url: Optional[str],
+    workspace: Optional[str],
+    set_current: bool,
+    readonly: bool,
+) -> None:
+    """Save SystemLink credentials to a profile.
+
+    This is an alias for 'slcli config add'. Use that command
+    for the same functionality and more configuration options.
+
+    Profiles allow you to configure multiple SystemLink environments and switch
+    between them. Credentials are stored in ~/.config/slcli/config.json.
+
+    Examples:
+        slcli login --profile dev
+        slcli login -p prod --url https://prod-api.example.com
+        slcli login --profile test --workspace "Testing" --readonly
+    """
+    from .config_click import _add_profile_impl
+
+    # Invoke the shared implementation
+    _add_profile_impl(
+        profile=profile,
+        url=url,
+        api_key=api_key,
+        web_url=web_url,
+        workspace=workspace,
+        set_current=set_current,
+        readonly=readonly,
+    )
+
+
+@cli.command()
+@click.option("--profile", "-p", help="Profile to remove (default: current profile)")
+@click.option("--all", "remove_all", is_flag=True, help="Remove all profiles")
+@click.option("--force", "-f", is_flag=True, help="Skip confirmation prompt")
+def logout(profile: Optional[str], remove_all: bool, force: bool) -> None:
+    """Remove stored SystemLink credentials.
+
+    By default, removes the current profile. Use --profile to remove a specific
+    profile, or --all to remove all profiles.
+
+    Also cleans up any legacy keyring entries.
+    """
+    from .profiles import ProfileConfig
+
+    cfg = ProfileConfig.load()
+
+    if remove_all:
+        if not force:
+            if not questionary.confirm(
+                "Remove all profiles and legacy keyring entries?",
+                default=False,
+            ).ask():
+                click.echo("Aborted.")
+                return
+
+        # Clear all profiles
+        cfg.profiles.clear()
+        cfg.current_profile = None
+        cfg.save()
+        click.echo("✓ All profiles removed.")
+
+    elif profile:
+        # Remove specific profile
+        if profile not in cfg.profiles:
+            click.echo(f"✗ Profile '{profile}' not found.", err=True)
+            return
+
+        if not force:
+            if not questionary.confirm(
+                f"Remove profile '{profile}'?",
+                default=False,
+            ).ask():
+                click.echo("Aborted.")
+                return
+
+        cfg.delete_profile(profile)
+        cfg.save()
+        click.echo(f"✓ Profile '{profile}' removed.")
+
+    else:
+        # Remove current profile
+        if not cfg.current_profile:
+            click.echo("No current profile set.", err=True)
+            return
+
+        current = cfg.current_profile
+        if not force:
+            if not questionary.confirm(
+                f"Remove current profile '{current}'?",
+                default=False,
+            ).ask():
+                click.echo("Aborted.")
+                return
+
+        cfg.delete_profile(current)
+        cfg.save()
+        click.echo(f"✓ Profile '{current}' removed.")
+        if cfg.current_profile:
+            click.echo(f"  Current profile is now: {cfg.current_profile}")
+
+    # Also clean up legacy keyring entries
+    try:
+        keyring.delete_password("systemlink-cli", "SYSTEMLINK_API_KEY")
+    except Exception:
+        pass
+    try:
+        keyring.delete_password("systemlink-cli", "SYSTEMLINK_API_URL")
+    except Exception:
+        pass
+    try:
+        keyring.delete_password("systemlink-cli", "SYSTEMLINK_CONFIG")
+    except Exception:
+        pass
+
+
+@cli.command()
+@click.option("--format", "-f", type=click.Choice(["table", "json"]), default="table")
+def info(format: str) -> None:
+    """Show current configuration and detected platform."""
+    from .profiles import ProfileConfig, get_active_profile
+
+    platform_info = get_platform_info()
+
+    # Add profile information
+    cfg = ProfileConfig.load()
+    active_profile = get_active_profile()
+    platform_info["current_profile"] = cfg.current_profile
+    platform_info["profile_count"] = len(cfg.profiles)
+    if active_profile:
+        platform_info["active_profile_workspace"] = active_profile.workspace
+        platform_info["active_profile_name"] = active_profile.name
+
+    if format == "json":
+        click.echo(json.dumps(platform_info, indent=2))
+        return
+
+    # Table format using box-drawing characters for key-value display.
+    # Note: This uses a custom layout rather than table_utils because table_utils
+    # is designed for list-style output (multiple uniform rows), while this command
+    # displays a single record with key-value pairs and feature availability.
+    # All text fields are truncated to prevent formatting issues with long values.
+    max_value_width = 45  # Maximum width for values before truncation
+    content_width = 61  # Total width inside the box
+
+    def truncate(value: str, max_len: int = max_value_width) -> str:
+        """Truncate a string with ellipsis if it exceeds max length."""
+        if len(value) > max_len:
+            return value[: max_len - 3] + "..."
+        return value
+
+    click.echo("\n┌" + "─" * content_width + "┐")
+    click.echo("│" + "SystemLink CLI Info".center(content_width) + "│")
+    click.echo("├" + "─" * content_width + "┤")
+
+    # Connection status
+    status = "✓ Connected" if platform_info["logged_in"] else "✗ Not logged in"
+    click.echo(f"│  Status:    {status:<48}│")
+
+    # Profile information
+    profile_display = platform_info.get("active_profile_name", "None")
+    if platform_info.get("profile_count", 0) > 1:
+        profile_display = f"{profile_display} (1 of {platform_info['profile_count']})"
+    profile_display = truncate(profile_display)
+    click.echo(f"│  Profile:   {profile_display:<48}│")
+
+    # Platform
+    platform_display = truncate(platform_info.get("platform_display", "Unknown"))
+    click.echo(f"│  Platform:  {platform_display:<48}│")
+
+    # API URL
+    api_url = truncate(platform_info.get("api_url", "Not configured"))
+    click.echo(f"│  API URL:   {api_url:<48}│")
+
+    # Web URL
+    web_url = truncate(platform_info.get("web_url", "Not configured"))
+    click.echo(f"│  Web URL:   {web_url:<48}│")
+
+    # Default workspace
+    workspace = platform_info.get("active_profile_workspace")
+    if workspace:
+        workspace_display = truncate(workspace)
+        click.echo(f"│  Workspace: {workspace_display:<48}│")
+
+    click.echo("├" + "─" * content_width + "┤")
+    click.echo("│" + "Feature Availability".center(content_width) + "│")
+    click.echo("├" + "─" * content_width + "┤")
+
+    features = platform_info.get("features", {})
+    if features:
+        for feature_name, available in features.items():
+            status_icon = "✓" if available else "✗"
+            status_text = "Available" if available else "Not available"
+            # Truncate feature name if needed
+            display_name = truncate(feature_name, 29)
+            click.echo(f"│  {status_icon} {display_name:<30} {status_text:<26}│")
+    else:
+        if platform_info["platform"] == PLATFORM_UNKNOWN:
+            click.echo("│  Run 'slcli login' to detect platform features.            │")
+        else:
+            click.echo("│  No feature information available.                          │")
+
+    click.echo("└" + "─" * content_width + "┘\n")
+
+
+register_completion_command(cli)
+register_asset_commands(cli)
+register_comment_commands(cli)
+register_dff_commands(cli)
+register_config_commands(cli)
+register_example_commands(cli)
+register_feed_commands(cli)
+register_file_commands(cli)
+register_function_commands(cli)
+register_mcp_commands(cli)
+register_templates_commands(cli)
+register_notebook_commands(cli)
+register_policy_commands(cli)
+register_routine_commands(cli)
+register_system_commands(cli)
+register_tag_commands(cli)
+register_testmonitor_commands(cli)
+register_webapp_commands(cli)
+register_skill_commands(cli)
+register_user_commands(cli)
+register_workitem_commands(cli)
+register_workspace_commands(cli)