Skip to main content

Task Runner (Just)

This project uses Just as the task runner. It provides a single entry point for all common operations across Python, TypeScript, Go, and shell scripts.

Install​

# macOS
brew install just

# Linux
curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | bash -s -- --to /usr/local/bin

Available Recipes​

Run just --list to see all recipes:

Available recipes:
    build                             # Build TypeScript sources
    cf-login                          # Log in to Cloudflare (opens browser)
    cf-whoami                         # Check Cloudflare auth status
    clean                             # Remove build artifacts and caches
    clean-all                         # Remove everything (venv, node_modules, Go cache)
    docs-build                        # Build Docusaurus site (generates llms.txt)
    docs-dev                          # Start Docusaurus dev server
    docs-serve                        # Serve Docusaurus production build locally
    prereqs                           # Install prerequisites
    ps                                # Run PowerShell SDK example
    py                                # Run Python SDK example
    setup                             # Install all SDKs and CLI (non-interactive)
    setup-interactive                 # Install all SDKs and CLI (interactive)
    setup-docs                        # Clone SailPoint developer docs locally
    setup-go                          # Download Go SDK dependencies
    setup-python                      # Create Python venv and install SDK
    setup-ts                          # Install TypeScript SDK and Connector SDK
    sources                           # List sources via SailPoint CLI
    transforms                        # List transforms via SailPoint CLI
    ts                                # Run TypeScript SDK example
    upload sourceId file              # Upload accounts to a flat file source
    upload-dry sourceId file          # Dry-run validate a CSV before uploading
    upload-entitlements sourceId file # Upload entitlements to a flat file source
    verify                            # Verify all SDKs and CLI are installed

Usage Examples​

# Full setup from scratch
just prereqs
just setup

# Check everything is working
just verify

# Build and run TypeScript
just build
just ts

# Upload a CSV
just upload abc123def456 data/accounts.csv

# Start the docs site
just docs-dev