Skip to content

CLI Installation

Quick Install

bash
pip install socket0-sdk[cli]

Installation Methods

Using pip

bash
pip install socket0-sdk[cli]

Using UV

bash
uv pip install socket0-sdk[cli]

Development Installation

bash
# Clone repository
git clone https://github.com/socket0/socket0-python-sdk.git
cd socket0-python-sdk

# Install with CLI (editable mode)
uv pip install -e ".[cli]"

Verify Installation

bash
s0 --version
s0 --help

Dependencies

When you install socket0-sdk[cli], you get:

PackageVersionPurpose
typer[all]>=0.12.0CLI framework
rich>=13.7.0Terminal formatting
python-dotenv>=1.0.0Environment variable support

Plus all core SDK dependencies:

  • httpx - Async HTTP client
  • pycryptodomex - Cryptography
  • pydantic - Data validation

Shell Completion

Bash

bash
# Add to ~/.bashrc or ~/.bash_profile
eval "$(_S0_COMPLETE=bash_source s0)"

Zsh

bash
# Add to ~/.zshrc
eval "$(_S0_COMPLETE=zsh_source s0)"

Fish

bash
# Add to ~/.config/fish/completions/s0.fish
_S0_COMPLETE=fish_source s0 | source

Troubleshooting

Command Not Found

If s0 is not found after installation:

  1. Verify installation: pip list | grep socket0-sdk
  2. Check Python path: which python
  3. Reinstall: pip install --force-reinstall socket0-sdk[cli]

Import Errors

If you get import errors when running CLI commands:

bash
# Ensure CLI dependencies are installed
pip install socket0-sdk[cli]

# Or upgrade
pip install --upgrade socket0-sdk[cli]

Permission Denied

If you get permission errors:

bash
# Use --user flag
pip install --user socket0-sdk[cli]

# Or use a virtual environment (recommended)
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install socket0-sdk[cli]

Next Steps

Socket0 Python SDK License - Not open source. For usage terms see /license