Installation¶

Prerequisites¶

• Python 3.8 or higher
• pip or uv package manager

Installation Methods¶

Using pip¶

pip install xx-shell

Using uv¶

uv pip install xx-shell

From Source¶

1. Clone the repository:

   git clone https://github.com/your-org/xx-shell.git
   cd xx-shell
   

2. Install dependencies:

   uv pip install -r requirements.txt
   

3. Install the package:

   uv pip install -e .
   

Quickstart Example¶

# Install XX
pip install xx-shell

# Activate XX shell
xx activate

# Use natural language commands
xx> $ find "all media files under 500mb"

Verifying Installation¶

Run the following command to verify the installation:

xx-shell --version

Troubleshooting¶

If you encounter any issues: - Ensure Python is installed correctly - Check your PATH environment variable - Verify pip/uv is up to date