Installation
This guide will help you install VMware vRA CLI on your system.
Prerequisites
System Requirements
- Python 3.10 or higher
- Network access to your VMware vRA 8 environment
- Valid vRA user credentials
Installation Methods
Option 1: Install with pipx (Recommended)
pipx is the recommended way to install Python CLI applications:
# Install pipx if you haven't already
python3 -m pip install --user pipx
python3 -m pipx ensurepath
# Install VMware vRA CLI
pipx install vmware-vra-cli
Option 2: Install with pip
Option 3: Install from source
For development or the latest features:
# Clone the repository
git clone https://github.com/brun_s/vmware-vra-cli.git
cd vmware-vra-cli
# Install with uv (recommended)
uv sync --extra dev
uv run vra --help
# Or install with pip
pip install -e .
Verification
Verify your installation:
You should see output similar to:
Next Steps
Now that you have the CLI installed, you can:
- Configure your environment - Set up your vRA connection
- Try the Quick Start guide - Create your first VM
- Read the User Guide - Learn about advanced features
Troubleshooting
Common Issues
Python Version Error
Solution: Upgrade your Python version or use a virtual environment with Python 3.10+.
Permission Denied
Solution: Use --user
flag or install in a virtual environment:
Command Not Found
Solution: Ensure your PATH includes the Python scripts directory:
Getting Help
If you encounter issues:
- Check the GitHub Issues
- Create a new issue with:
- Your operating system
- Python version (
python --version
) - Error message or unexpected behavior
- Steps to reproduce