Install the CSDS CLI

Requirements

• ✓ Python 3.10 or newer
• ✓ pip or pipx
• ✓ Internet connection

Check your Python version: python3 --version

pipx installs CLI tools in isolated environments so they never conflict with your other Python projects.

1. Install pipx (if you don't have it)

# macOS
brew install pipx
pipx ensurepath

# Linux / Windows (WSL)
python3 -m pip install --user pipx
python3 -m pipx ensurepath

2. Install csds-cli

pipx install csds-cli

3. Verify

csds --version
# csds 0.1.0

Option B: pip

pip install csds-cli

If csds isn't found after install, your pip scripts directory may not be on your PATH. Run pip show csds-cli to find the install location.

Option C: From Source (Development)

git clone https://github.com/blockchainrangers/csds.git
cd csds/cli
pip install -e ".[dev]"

# Run tests
pytest tests/ -v

Your First Check

You get 3 free lifetime lookups with no account or wallet required.

# Analyze an Ethereum token
csds check 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb --chain ethereum

# Auto-detect chain from address format
csds check EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v

# Get JSON output (great for scripts)
csds check 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb --format json --no-color

Beyond the Free Tier

# Save your key permanently
csds config set api-key csds_your_key_here

# Or use an environment variable (great for CI/CD)
export CSDS_API_KEY=csds_your_key_here

# Coming soon
csds auth setup        # Generate or import a wallet
csds auth fund         # Get your wallet address to fund it
export CSDS_WALLET_KEY=0x...  # Or set directly

CI/CD Setup

Use the CLI as a token screening gate in GitHub Actions or any CI pipeline.

# GitHub Actions example
- name: Screen token before listing
  run: |
    pip install csds-cli
    SCORE=$(csds check ${{ inputs.token_address }} --format json --no-color | jq '.risk_score')
    if [ "$SCORE" -gt 60 ]; then
      echo "Token failed safety screening (score: $SCORE)"
      exit 1
    fi
  env:
    CSDS_API_KEY: ${{ secrets.CSDS_API_KEY }}

Troubleshooting