plano/arch/tools/README.md
Adil Hafeez c254dfb16a
update cli and update docs (#161)
* add services to cli

* more changes
2024-10-09 16:22:27 -07:00

1.2 KiB

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:

python -m venv venv

Step 2: Activate the virtual environment

  • On Linux/MacOS:
source venv/bin/activate

Step 3: Run the build script

pip install archgw

Uninstall Instructions: archgw CLI

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:

python -m venv venv

Step 2: Activate the virtual environment

  • On Linux/MacOS:
source venv/bin/activate

Step 3: Run the build script

sh build_cli.sh

Step 4: build Arch

archgw build

Step 5: start model server in the background

archgw up --services model_server

Uninstall Instructions: archgw CLI

pip uninstall archgw