plano/arch/tools/README.md
Salman Paracha ebda682b30
updated docs for 0.1.8 support (#366)
* updated docs for 0.1.8 support

* updated REAMDE on root

* updated version reference to 0.1.8 in other parts of the repo

---------

Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local>
2025-01-10 16:38:48 -08:00

75 lines
1.4 KiB
Markdown

## Setup Instructions(User): archgw CLI
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
pip install archgw==0.1.8
```
## Uninstall Instructions: archgw CLI
```bash
pip uninstall archgw
```
## 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
poetry install
```
### Step 4: build Arch
```bash
archgw build
```
### Step 5: download models
This will help download models so model_server can load faster. This should be done once.
```bash
archgw download-models
```
### Logs
`archgw` command can also view logs from gateway and model_server. Use following command to view logs,
```bash
archgw logs --follow
```
## Uninstall Instructions: archgw CLI
```bash
pip uninstall archgw