Privateer SDK

The Privateer SDK provides the interface and utilities needed for developing Privateer plugins. It includes common logic, cloud provider utilities, and an evaluation framework that can be reused across multiple plugins.

Documentation

For complete SDK documentation, visit privateerproj.com/developer-reference/

The website includes:

• Detailed SDK overview and components
• Plugin development guides
• API reference and examples
• Best practices and patterns

Quick Start

Installation

Add the SDK to your Go project:

go get github.com/privateerproj/privateer-sdk

Usage

Import the SDK in your plugin:

import (
    "github.com/privateerproj/privateer-sdk/pluginkit"
    "github.com/privateerproj/privateer-sdk/config"
    "github.com/privateerproj/privateer-sdk/shared"
)

See the plugin development guide for detailed usage examples.

API Reference

• pkg.go.dev Documentation - Complete API reference
• SDK Documentation - Developer guide and tutorials

Local Development

Prerequisites

• Go 1.26.2 or later - Required for building and testing
• Make - For using the Makefile build targets

Building

make build

Testing

Run all tests:

make test

Run tests with coverage:

make testcov

Available Make Targets

• make build - Build all packages
• make test - Run tests and vet checks
• make testcov - Run tests with coverage report
• make tidy - Clean up go.mod dependencies
• make quick - Alias for make build

Project Structure

privateer-sdk/
├── command/        # CLI command utilities
├── config/         # Configuration management
├── pluginkit/      # Core plugin kit functionality
├── shared/         # Shared plugin interfaces
└── utils/          # Utility functions

Contributing

We welcome contributions! See our Contributing Guidelines for details.

All contributions are covered by the Apache 2 License at the time the pull request is opened, and all community interactions are governed by our Code of Conduct.

Security

For vulnerability reporting, please reference our Security Policy. Please do not open public issues for security vulnerabilities or questions. Report them privately through GitHub private vulnerability reporting instead.

See CRA-READINESS.md for how the project voluntarily documents its security practices against the EU Cyber Resilience Act (CRA) readiness checklist.

Helpful Links

• Privateer SDK - SDK for developing Privateer plugins
• Privateer Documentation - Complete documentation site
• Example Plugin - Reference implementation