Workspace Setup

This guide walks you through setting up a PLESTY development workspace from scratch.

Step 1: Clone the repositories

PLESTY development requires the core repositories. Clone them into a repos/ directory:

mkdir -p repos/core
git clone git@gitlab.com:plesty/core/plesty-sdk.git repos/core/plesty-sdk
git clone git@gitlab.com:plesty/core/plesty-lib.git repos/core/plesty-lib
git clone git@gitlab.com:plesty/core/plesty-ci.git repos/core/plesty-ci

For device development, you'll also want the hub repositories:

mkdir -p repos/hub
git clone git@gitlab.com:plesty/hub/devices/thorlabs.git repos/hub/devices/thorlabs

Step 2: Install the SDK

The SDK (plesty-sdk) provides the plesty CLI tool. Install it with uv:

cd repos/core/plesty-sdk
uv sync
uv run plesty --help

This installs all dependencies and makes the plesty commands available.

Step 3: Install the library

The library (plesty-lib) provides base classes for devices, analyzers, and experiments:

cd repos/core/plesty-lib
uv sync

Step 4: Configure your environment

Create a .env file in your workspace root with any needed configuration:

# .env.example
PLESTY_ROOT=/path/to/workspace

The SDK reads this file to locate repositories and configuration.

Step 5: Verify the setup

Run the environment doctor to verify everything is installed correctly:

cd repos/core/plesty-sdk
uv run plesty check --standard pixel

If all checks pass, your workspace is ready.

Troubleshooting

Next steps

• Run your first check on a device module
• Learn how to fix common failures