Skip to main content

CLI tool for publishing tools and UI modules to the BrowsEZ platform

Project description

BrowsEZ CLI

A command-line tool for publishing tools and UI modules to the BrowsEZ platform.

Installation

From PyPI (when published)

pip install browsez-cli

From Source (Development)

# Clone and install in editable mode
cd cli-mode
pip install -e .

Quick Start

# Login to the platform
browsez login

# Validate a tool before publishing
browsez validate path/to/tool_directory

# Publish a tool
browsez publish path/to/tool_directory

Commands

Command Description
browsez login Login to the BrowsEZ platform
browsez logout Clear the current session
browsez validate <dir> Validate a tool without uploading
browsez publish <dir> Publish a tool to the backend
browsez publish-ui <dir> Publish a UI module (coming soon)
browsez config show Show current configuration
browsez config set <key> <value> Set a config value

Configuration

The CLI uses a .toolrc.json file for configuration. It is auto-created on first run:

{
  "api_base_url": "https://browsez-platform-backend-production.up.railway.app",
  "tenant_id": "sample-tenant-123",
  "default_risk_level": "MEDIUM",
  "upload_timeout": 300,
  "retry_attempts": 3
}

Override settings via CLI:

browsez config set api-url https://api.example.com
browsez config set risk-level HIGH

Tool Directory Structure

A valid tool directory must have:

tool_name/
├── tool.yaml           # Metadata (name, inputs, outputs)
├── requirements.txt    # Python dependencies
└── src/
    ├── __init__.py
    └── main.py         # Entry point (run function, Input/Output classes)

Development

# Install with dev dependencies
pip install -e ".[dev]"

# Build the package
python -m build

# Upload to PyPI (requires twine and credentials)
twine upload dist/*

Features

  • Strict Schema Validation: Ensures tools meet all requirements before packaging
  • Deterministic Packaging: Creates consistent zip files with content-based hashing (SHA-256)
  • Secure Uploads: Uses pre-signed S3 URLs for artifacts
  • Configurable: Supports configuration via file, CLI arguments, and defaults
  • Resilient: Implements retry logic and exponential backoff for network operations

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

browsez_cli-0.1.0.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

browsez_cli-0.1.0-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file browsez_cli-0.1.0.tar.gz.

File metadata

  • Download URL: browsez_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for browsez_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0c08a396bedcd66e25062b4e9bdd4c66d5ed6580d298d75a6a0f2833106c8d53
MD5 3e643a0ffeb14adc5ff09b74dde413d9
BLAKE2b-256 0a9b349a6e144c4cf77d9dc911578ca67ef5f45b11e27c152b1930554e721b56

See more details on using hashes here.

File details

Details for the file browsez_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: browsez_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for browsez_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d8c244a82f6d0d877fe8ffdca20e17810dd3917a23ca0010089f706b4beb151b
MD5 6cf31760054165a48faba51ace88fc28
BLAKE2b-256 59aa873d31f8f093db433c45dac269cb7c0bb56660f61addb15f54130cbd7aea

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page