Metadata-Version: 2.4
Name: novavision-cli
Version: 0.0.8
Summary: NovaVision CLI for handling servers.
Author: İlhan Kaan Yazıcıoğlu
Author-email: ilhan.kaan.yazicioglu@diginova.com.tr
License: Apache-2.0
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests==2.32.3
Requires-Dist: psutil==6.1.1
Requires-Dist: docker<7,>=6.1.3
Requires-Dist: rich==13.9.4
Requires-Dist: pyyaml==6.0.2
Requires-Dist: pyobjc; sys_platform == "darwin"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Novavision CLI

NovaVision CLI offers an interface for managing servers and applications locally. It allows you to register and install a server, deploy, and manage an app using Docker Compose.

NovaVision simplifies the process of setting up and managing servers, allowing you to deploy and run applications on edge, local, and cloud servers.

---

## Installation

Install NovaVision CLI using pipx:

```bash
# Install pipx if not already installed
python -m pip install --user pipx
python -m pipx ensurepath

# Install NovaVision CLI with pipx
pipx install novavision-cli

# Verify Installation
novavision --help
```

---

## Features

### **install**  
Performs creation and installation of a device on your system.

```bash
novavision install [edge|local|cloud] <USER_TOKEN> --host <HOST> --workspace <USER_WORKSPACE_NAME>
```

**Parameters**  
- `DEVICE_TYPE`: Specifies the server type. Options: `edge`, `local`, or `cloud`.  
- `USER_TOKEN`: User token required for registering and installing the server.
- `--host`: User can specify which host will be used for creating device. Default: `alfa.suite.novavision.ai`. Choices: `alfa.suite.novavision.ai | dev.suite.novavision.ai | suite.novavision.ai`
- `--workspace`: User can specify which workspace will be used for creating device. User must type the name of the workspace they have. If this parameter is not entered, workspace selection will be performed while device creation. 

---

### **novavision start**  
Launches the server's or application's Docker Compose environment, starting the server or application if it isn’t already running.

```bash
novavision start [server|app] --id <APP_ID>
```

**Parameters**  
- `--id <APP_ID>` *(Optional, required only for apps)*: Specifies which application to start.

---

### **stop**  
Stops the running server or application by shutting down its Docker Compose environment.

```bash
novavision stop [server|app] --id <APP_ID>
```

**Parameters**  
- `--id <APP_ID>` *(Optional, required only for apps)*: Specifies which application to stop.
