plano/arch/tools
2024-10-10 17:44:41 -07:00
..
cli Improve cli (#179) 2024-10-10 17:44:41 -07:00
test lint + formating with black (#158) 2024-10-09 11:25:07 -07:00
__init__.py archgw cli (#117) 2024-10-03 18:21:27 -07:00
build_cli.sh rename 2024-10-09 16:24:40 -07:00
MANIFEST.in Salmanap/fix config generator (#124) 2024-10-05 10:49:47 -07:00
poetry.lock Improve cli (#179) 2024-10-10 17:44:41 -07:00
pyproject.toml Improve cli (#179) 2024-10-10 17:44:41 -07:00
README.md Improve cli (#179) 2024-10-10 17:44:41 -07:00
setup.py lint + formating with black (#158) 2024-10-09 11:25:07 -07:00

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: download models

This will help download models so model_server can load faster. This should be done once.

archgw download-models

Logs

archgw command can also view logs from gateway and model_server. Use following command to view logs,

archgw logs --follow

Uninstall Instructions: archgw CLI

pip uninstall archgw