2024-10-09 15:53:12 -07:00
|
|
|
## Setup Instructions(User): archgw CLI
|
2024-10-03 18:21:27 -07:00
|
|
|
|
|
|
|
|
This guide will walk you through the steps to set up the archgw cli on your local machine
|
|
|
|
|
|
|
|
|
|
### Step 1: Create a Python virtual environment
|
|
|
|
|
|
|
|
|
|
In the tools directory, create a Python virtual environment by running:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
python -m venv venv
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Step 2: Activate the virtual environment
|
|
|
|
|
* On Linux/MacOS:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
source venv/bin/activate
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Step 3: Run the build script
|
|
|
|
|
```bash
|
2024-10-09 15:53:12 -07:00
|
|
|
pip install archgw
|
2024-10-03 18:21:27 -07:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Uninstall Instructions: archgw CLI
|
|
|
|
|
```bash
|
|
|
|
|
pip uninstall archgw
|
|
|
|
|
```
|
2024-10-09 15:53:12 -07:00
|
|
|
|
|
|
|
|
## Setup Instructions (Dev): archgw CLI
|
|
|
|
|
|
|
|
|
|
This guide will walk you through the steps to set up the archgw cli on your local machine when you want to develop the Archgw CLI
|
|
|
|
|
|
|
|
|
|
### Step 1: Create a Python virtual environment
|
|
|
|
|
|
|
|
|
|
In the tools directory, create a Python virtual environment by running:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
python -m venv venv
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Step 2: Activate the virtual environment
|
|
|
|
|
* On Linux/MacOS:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
source venv/bin/activate
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Step 3: Run the build script
|
|
|
|
|
```bash
|
2024-10-09 16:22:27 -07:00
|
|
|
sh build_cli.sh
|
2024-10-09 15:53:12 -07:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Step 4: build Arch
|
|
|
|
|
```bash
|
|
|
|
|
archgw build
|
|
|
|
|
```
|
|
|
|
|
|
2024-10-09 16:22:27 -07:00
|
|
|
## Step 5: start model server in the background
|
|
|
|
|
```
|
|
|
|
|
archgw up --services model_server
|
|
|
|
|
```
|
2024-10-09 15:53:12 -07:00
|
|
|
|
|
|
|
|
## Uninstall Instructions: archgw CLI
|
|
|
|
|
```bash
|
|
|
|
|
pip uninstall archgw
|