easyp

EasyP

Modern Protocol Buffers toolkit for streamlined development workflows

The easyp CLI is a comprehensive tool for working with Protocol Buffers. It provides:

• A linter that enforces good API design choices and structure
• A breaking change detector that ensures compatibility at the source code level
• A generator that invokes plugins based on configuration files
• A package manager with Git-based dependency management
• Integration with remote plugins for consistent, isolated execution

Installation

Homebrew

You can install easyp using Homebrew (macOS or Linux):

brew install easyp-tech/tap/easyp

Go Install

go install github.com/easyp-tech/easyp/cmd/easyp@latest

Other methods

For other installation methods, see our official documentation, which covers:

• Installing easyp via npm
• Using easyp as a Docker image
• Installing as a binary from GitHub Releases

Quick Start

# Initialize a new project
mkdir my-proto-project && cd my-proto-project
easyp init

# Add your .proto files to the project
mkdir api
# ... add your .proto files to api/ ...

# Download dependencies and generate code
easyp mod download
easyp generate

# Lint your proto files
easyp lint

# Check for breaking changes
easyp breaking --against main

Usage

EasyP's help interface provides summaries for commands and flags:

easyp --help

For comprehensive usage information, consult EasyP's documentation, especially these guides:

• What is EasyP? - Overview and key concepts
• easyp init - Project initialization
• easyp lint - Code linting and validation
• easyp breaking - Breaking change detection
• easyp mod - Package management
• easyp generate - Code generation

Key Features

• 🔍 Comprehensive Linting - Built-in support for buf's linting rules with customizable configurations
• 📦 Smart Package Manager - Git-based dependency management with lock file support
• ⚡ Code Generation - Multi-language generation with local and remote plugin support
• 🔄 Breaking Change Detection - Automated API compatibility verification against Git branches
• 🌐 Remote Plugin Support - Execute plugins via centralized EasyP API service
• 🎯 Developer Experience - Auto-completion, intuitive commands, and clear error messages

Why choose EasyP over buf.build?

While buf.build provides excellent protobuf tooling, EasyP offers several key advantages:

Key Benefits:

• No infrastructure changes: Use your existing Git repositories for proto dependencies
• Enhanced flexibility: Execute plugins both locally and remotely for consistent results
• Simplified configuration: Single file for all protobuf operations
• Full buf compatibility: Drop-in replacement with familiar rule sets and configuration

Our goals for Protobuf

EasyP's goal is to make Protocol Buffers development more accessible and reliable by providing a unified toolkit that eliminates the complexity of traditional protobuf workflows. We've built on the proven foundation of Protocol Buffers and buf's excellent design principles to create a modern development experience.

While Protocol Buffers offer significant technical advantages over REST/JSON, actually using them has traditionally been more challenging than necessary. EasyP aims to change that by consolidating the entire protobuf workflow into a single, intuitive tool with Git-native dependency management and both local and remote plugin execution.

Configuration

EasyP uses a single easyp.yaml file for all configuration:

version: v1alpha

# Dependencies
deps:
  - github.com/googleapis/googleapis@common-protos-1_3_1
  - github.com/bufbuild/protoc-gen-validate@v0.9.1

# Code generation
generate:
  inputs:
    - directory: "api"
  plugins:
    - name: go
      out: .
      opts:
        paths: source_relative
    - remote: api.easyp.tech/protoc-gen-typescript:latest
      out: ./web/generated

# Linting
lint:
  use:
    - DIRECTORY_SAME_PACKAGE
    - PACKAGE_DEFINED
    - FIELD_LOWER_SNAKE_CASE
    - MESSAGE_PASCAL_CASE

Community

For help and discussion around EasyP and Protocol Buffers best practices:

• 📖 Documentation - Comprehensive guides and API reference
• 💬 Telegram Chat - Community discussion and support
• 🐛 GitHub Issues - Bug reports and feature requests
• ✉️ Contact - Direct contact for enterprise support

Next steps

Once you've installed easyp, we recommend completing the Quick Start tutorial, which provides a hands-on overview of the core functionality. The tutorial takes about 10 minutes to complete.

After completing the tutorial, check out the documentation for your specific areas of interest.

License

EasyP is released under the Apache License 2.0.

Built with ❤️ for the Protocol Buffers community