Skip to content

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

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

pip install vmware-vra-cli

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:

vra --version

You should see output similar to:

VMware vRA CLI v0.1.0

Next Steps

Now that you have the CLI installed, you can:

  1. Configure your environment - Set up your vRA connection
  2. Try the Quick Start guide - Create your first VM
  3. Read the User Guide - Learn about advanced features

Troubleshooting

Common Issues

Python Version Error

ERROR: Python 3.10 or higher is required

Solution: Upgrade your Python version or use a virtual environment with Python 3.10+.

Permission Denied

ERROR: Could not install packages due to an EnvironmentError: [Errno 13] Permission denied

Solution: Use --user flag or install in a virtual environment:

pip install --user vmware-vra-cli

Command Not Found

vra: command not found

Solution: Ensure your PATH includes the Python scripts directory:

# Add to your shell profile (.bashrc, .zshrc, etc.)
export PATH="$PATH:$HOME/.local/bin"

Getting Help

If you encounter issues:

  1. Check the GitHub Issues
  2. Create a new issue with:
  3. Your operating system
  4. Python version (python --version)
  5. Error message or unexpected behavior
  6. Steps to reproduce