onex-cli 1.0.0__tar.gz

onex_cli-1.0.0/CHANGELOG.md

@@ -0,0 +1,78 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-02-19
+
+### Added
+- **VPN Module**: Complete cross-platform VPN setup support (macOS, Linux, Windows)
+  - `onex vpn setup` - Setup VPN from WireGuard config file
+  - `onex vpn connect/disconnect` - Manage VPN connections
+  - `onex vpn status` - Check VPN connection status
+  - Automatic environment detection from VPN IP ranges
+
+- **One-Command Setup**: `onex init` command for complete environment setup
+  - Automatic VPN setup and connection
+  - Platform login with credential download
+  - Auto-generated .env file in service repository
+  - Connectivity verification
+
+- **Environment Management**: Enhanced environment switching and configuration
+  - `onex env` - Show active environment
+  - `onex env sync` - Regenerate .env file
+  - `onex use <env>` - Switch active environment
+  - Automatic credential storage in `~/.onex/`
+
+- **Debug Mode**: VS Code debugging support with debugpy
+  - `onex debug --service <name>` - Start service with debugger
+  - Hot-reload for code changes
+  - Breakpoint debugging support
+
+- **Platform Commands**: Platform management utilities
+  - `onex platform health` - Check platform health
+  - `onex platform info` - Show platform information
+
+- **Service Deployment**: Deploy services to OneXERP platform
+  - `onex deploy` - Deploy from service directory
+  - `onex validate` - Validate service.yml schema
+  - Real-time deployment progress
+
+- **Monitoring & Debugging**:
+  - `onex trace <trace_id>` - End-to-end request tracing
+  - `onex logs <service>` - View service logs
+  - `onex status <service>` - Check service status
+
+- **Service Management**:
+  - `onex invoke <service>:<function>` - Direct function invocation
+  - `onex provision <service>` - Provision service resources
+
+### Security
+- Removed hardcoded credentials and tokens
+- Added placeholder values with clear instructions
+- Documented all example IPs and URLs as customizable
+- Secure credential storage in `~/.onex/` with proper permissions
+
+### Documentation
+- Complete VPN setup guide for developers
+- Updated developer guide with simplified workflow
+- Added troubleshooting sections
+- Documented all CLI commands and options
+
+### Changed
+- Installation method from local file to PyPI package
+- Simplified developer onboarding from 5 steps to 2 steps
+- Service repository no longer requires platform repository access
+
+## [0.1.0] - 2026-02-12
+
+### Added
+- Initial release
+- Basic deployment functionality
+- Service validation
+- Login/logout commands
+
+[1.0.0]: https://github.com/onexerp/onex-cli/releases/tag/v1.0.0
+[0.1.0]: https://github.com/onexerp/onex-cli/releases/tag/v0.1.0

onex_cli-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 OneXERP Platform Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

onex_cli-1.0.0/MANIFEST.in

@@ -0,0 +1,16 @@
+# Include important package files
+include README.md
+include LICENSE
+include CHANGELOG.md
+
+# Include package data
+recursive-include onex *.py
+recursive-include onex *.yml
+recursive-include onex *.yaml
+
+# Exclude Python cache and build artifacts
+global-exclude __pycache__
+global-exclude *.py[co]
+global-exclude .DS_Store
+global-exclude *.so
+global-exclude .git*

onex_cli-1.0.0/PKG-INFO

@@ -0,0 +1,387 @@
+Metadata-Version: 2.4
+Name: onex-cli
+Version: 1.0.0
+Summary: Official CLI for deploying and managing services on OneXERP Platform
+Home-page: https://github.com/onexerp/onex-cli
+Author: OneXERP Platform Team
+Author-email: platform@onexerp.com
+Project-URL: Documentation, https://github.com/onexerp/onex-cli#readme
+Project-URL: Bug Reports, https://github.com/onexerp/onex-cli/issues
+Project-URL: Source, https://github.com/onexerp/onex-cli
+Project-URL: Changelog, https://github.com/onexerp/onex-cli/blob/main/CHANGELOG.md
+Keywords: onexerp platform cli deployment serverless microservices vpn wireguard
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1.7
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: requests>=2.31.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pydantic>=2.0.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# OneXERP Platform CLI (`onex`)
+
+Official CLI tool for deploying and managing services on the OneXERP Platform.
+
+## Overview
+
+The `onex` CLI provides a unified interface for:
+- Deploying services to different environments (local/dev/staging/prod)
+- Validating service configurations (`service.yml`)
+- Invoking service functions directly
+- Tracing requests through the platform
+- Viewing service logs and status
+- Managing service resources
+
+## Installation
+
+### For Service Developers
+
+```bash
+# From onexerp-services repository root:
+pip install -e ../onexerp-platform-NEW/onex-cli
+
+# Or add to requirements.txt:
+onex-cli @ file:../onexerp-platform-NEW/onex-cli
+```
+
+### For Platform Developers
+
+The CLI is automatically available when working in the platform repository:
+
+```bash
+# From onexerp-platform-NEW:
+cd onex-cli
+pip install -e .
+```
+
+## Usage
+
+### Deploy a Service
+
+```bash
+# Deploy to local environment
+onex deploy
+
+# Deploy to specific environment
+onex deploy --env dev
+onex deploy --env staging
+onex deploy --env prod
+
+# Deploy from specific directory
+onex deploy --service-dir ./services/product
+```
+
+### Validate Service Configuration
+
+```bash
+# Validate service.yml without deploying
+onex validate
+
+# Validate specific service
+onex validate --service-dir ./services/product
+```
+
+### Invoke Functions
+
+```bash
+# Sync invoke (returns result immediately)
+onex invoke product:calculateTotal '{"items": [...]}'
+
+# Async invoke (fire and forget)
+onex invoke --async product:processLargeFile '{"file_id": "123"}'
+
+# Specify environment
+onex invoke --env dev product:calculateTotal '{"items": [...]}'
+```
+
+### Trace Requests
+
+```bash
+# Trace a request by trace_id
+onex trace 550e8400-e29b-41d4-a716-446655440000
+
+# Trace with environment
+onex trace 550e8400-e29b-41d4-a716-446655440000 --env local
+
+# Follow trace in real-time
+onex trace 550e8400-e29b-41d4-a716-446655440000 --follow
+
+# JSON output
+onex trace 550e8400-e29b-41d4-a716-446655440000 --json
+```
+
+### View Service Status
+
+```bash
+# Check service health and deployment status
+onex status product
+
+# Check all services
+onex status
+
+# Specify environment
+onex status product --env dev
+```
+
+### View Logs
+
+```bash
+# View service logs
+onex logs product
+
+# Follow logs in real-time
+onex logs product --follow
+
+# Last N lines
+onex logs product --lines 100
+```
+
+### Development Mode
+
+```bash
+# Run service locally with hot-reload
+onex dev
+
+# Specify service directory
+onex dev --service-dir ./services/product
+
+# Specify port
+onex dev --port 8001
+```
+
+### Initialize Configuration
+
+```bash
+# Interactive configuration setup
+onex init
+
+# Creates ~/.onex/config.yml with platform URLs and API keys
+```
+
+### Provision Resources
+
+```bash
+# Manually provision MongoDB collections, indexes, etc.
+onex provision
+
+# Specify environment
+onex provision --env dev
+```
+
+## Configuration
+
+The CLI uses `~/.onex/config.yml` for environment-specific settings:
+
+```yaml
+environments:
+  local:
+    platform_url: http://localhost:8000
+    deployment_url: http://localhost:8002
+  dev:
+    platform_url: https://dev-platform.onexerp.com
+    deployment_url: https://dev-platform.onexerp.com:8002
+    api_key: ${ONEX_DEV_API_KEY}
+  staging:
+    platform_url: https://staging-platform.onexerp.com
+    deployment_url: https://staging-platform.onexerp.com:8002
+    api_key: ${ONEX_STAGING_API_KEY}
+  prod:
+    platform_url: https://platform.onexerp.com
+    deployment_url: https://platform.onexerp.com:8002
+    api_key: ${ONEX_PROD_API_KEY}
+```
+
+## Service Configuration
+
+Services must include a `service.yml` file:
+
+```yaml
+name: product
+version: 1.0.0
+description: Product management service
+
+deployment:
+  mode: shared-runtime
+
+functions:
+  - name: getProduct
+    handler: src.handlers.get_product
+    triggers:
+      - type: http
+        path: /products/{id}
+        method: GET
+
+  - name: calculateTotal
+    handler: src.handlers.calculate_total
+    triggers: []  # Invoke-only function
+
+  - name: processFile
+    handler: src.handlers.process_file
+    triggers:
+      - type: s3
+        bucket: product-uploads
+        events: ["s3:ObjectCreated:*"]
+        prefix: images/
+```
+
+## Commands Reference
+
+| Command | Description |
+|---------|-------------|
+| `onex init` | Initialize CLI configuration (interactive) |
+| `onex validate` | Validate service.yml schema without deploying |
+| `onex deploy` | Deploy service to platform |
+| `onex dev` | Run service locally with hot-reload |
+| `onex invoke` | Invoke service functions directly |
+| `onex trace` | Track requests through platform with trace_id |
+| `onex logs` | View service logs |
+| `onex status` | Check service status and health |
+| `onex provision` | Manually provision MongoDB resources |
+
+## Development
+
+### Architecture
+
+```
+onex-cli/
+├── setup.py                 # Package configuration
+├── README.md               # This file
+└── onex/
+    ├── __init__.py
+    ├── __main__.py         # CLI entry point
+    ├── config.py           # Configuration management
+    ├── utils.py            # Shared utilities
+    ├── commands/           # Command implementations
+    │   ├── deploy.py
+    │   ├── trace.py
+    │   ├── invoke.py
+    │   ├── validate.py
+    │   ├── logs.py
+    │   ├── status.py
+    │   ├── dev.py
+    │   ├── init.py
+    │   └── provision.py
+    └── schema/
+        ├── service_descriptor.py → ../../platform-services/shared/schema/service_descriptor.py
+        └── validator.py
+```
+
+### Adding New Commands
+
+1. Create command file in `onex/commands/`
+2. Implement using Click decorators
+3. Register in `onex/__main__.py`
+
+Example:
+
+```python
+# onex/commands/newcommand.py
+import click
+from onex.config import get_config
+from onex.utils import print_success, print_error
+
+@click.command()
+@click.option('--env', default='local', help='Environment')
+def newcommand(env):
+    """Description of new command"""
+    config = get_config(env)
+    # Implementation here
+    print_success("Command completed!")
+
+# Register in onex/__main__.py
+from onex.commands import newcommand
+cli.add_command(newcommand.newcommand)
+```
+
+## Platform Integration
+
+The CLI integrates with these platform services:
+
+- **Deployment Controller** (8002) - Service deployment and versioning
+- **Gateway** (8000) - HTTP routing and function invocation
+- **Loki** (3100) - Log aggregation and trace queries
+- **Service Registry** (8500) - Service discovery and health checks
+
+## Schema Validation
+
+The CLI uses the platform's official schema from:
+```
+platform-services/shared/schema/service_descriptor.py
+```
+
+This ensures service configurations are validated against the same schema used by the deployment controller.
+
+## Troubleshooting
+
+### Command not found: onex
+
+```bash
+# Reinstall CLI in editable mode
+pip install -e /path/to/onexerp-platform-NEW/onex-cli
+
+# Verify installation
+which onex
+onex --version
+```
+
+### Import errors
+
+The CLI imports schema definitions from the platform. Ensure the platform repository is available:
+
+```bash
+# The symlink should exist:
+ls -la onex-cli/onex/schema/service_descriptor.py
+# → points to ../../platform-services/shared/schema/service_descriptor.py
+```
+
+### Deployment failures
+
+```bash
+# Validate service.yml first
+onex validate
+
+# Check platform health
+onex status --env local
+
+# View deployment logs
+onex logs deployment-controller
+```
+
+## License
+
+MIT License - See platform repository for details.
+
+## Support
+
+- **Platform Developers**: Update CLI in `onexerp-platform-NEW/onex-cli/`
+- **Service Developers**: Install CLI via `pip install -e ../onexerp-platform-NEW/onex-cli`
+- **Issues**: Report in platform repository
+
+## Related Documentation
+
+- [Platform Architecture](../docs/platform-developers/TRIGGER_SYSTEM.md)
+- [Service Development Guide](../docs/service-developers/QUICK_START.md)
+- [Deployment Guide](../docs/service-developers/DEPLOYING_SERVICES.md)
+- [Request Tracing](../docs/service-developers/REQUEST_TRACING.md)