CLI installation

The csds CLI is a Python package (requires Python 3.10+). Install it in an isolated environment with pipx, or however you prefer to manage Python tools.

Prerequisites

• Python 3.10 or newer — check with python --version.
• A package manager: pipx (recommended), pip, or uv.

Install

pipx (recommended)

pipx installs the CLI into its own isolated environment and puts csds on your PATH:

$ pipx install csds-cli
$ csds --version

pip

$ python -m pip install --user csds-cli

uv

$ uv tool install csds-cli

Verify

$ csds --version
$ csds check 0x6982508145454ce325ddbe47a25d4ec3d2311933

Upgrade & uninstall

$ pipx upgrade csds-cli
$ pipx uninstall csds-cli

Use in CI

Install and run the CLI in a pipeline; the exit code flags risky contracts automatically:

jobs:
  screen:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/setup-python@v5
        with: { python-version: "3.12" }
      - run: pipx install csds-cli
      - run: csds check ${{ vars.CONTRACT }} --chain ethereum --no-color

Troubleshooting

Next