Quickstart

EasyP is a modern toolkit for working with Protobuf files. In this quickstart, you'll learn to:

Initialize your project with EasyP configuration
Set up linting to catch errors and ensure best practices
Manage dependencies from Git repositories
Generate code from your Protobuf files

Prerequisites

Before you begin, make sure you have:

EasyP CLI installed - See Installation guide if you haven't already
Git installed and available in your system path
Protobuf files ready to work with

Verify your installation for your platform:

easyp --version

Initialize your project

Start by creating an easyp.yaml configuration file in your project root:

easyp init

This interactive command checks for existing buf.yaml files to offer automatic migration and generates a base easyp.yaml.

Configure linting

Linting helps catch errors and ensures your Protobuf files follow best practices. EasyP provides default rules compatible with Buf standards.

Run the linter across all .proto files in your project tree:

easyp lint

EasyP's linting rules are 100% compatible with Buf, making migration seamless if you're switching tools.

Manage dependencies

If your project uses third-party Protobuf packages (like Google APIs or gRPC Gateway), EasyP makes it easy to manage them via protobuf.mod or easyp.yaml.

Dependency format

Dependencies use a simple format: $GIT_LINK@$VERSION

$GIT_LINK - URL to any Git repository (GitHub, GitLab, etc.)
$VERSION - Git tag or commit hash (optional)

Add and download dependencies

# Download dependencies defined in configuration
easyp mod download

# Update dependencies to the latest matching minimums
easyp mod update

Tip: Use easyp mod update to fetch updated dependencies and refresh protobuf.lock.

Generate code

Now let's configure code generation. EasyP supports all standard Protobuf plugins.

Execute code generation across all target configurations:

easyp generate

EasyP uses a hybrid execution model with WASM for blazing speed and remote/Docker executors for heavy plugins.

Next steps

Congratulations! 🎉 You've successfully:

✅ Initialized an EasyP project
✅ Configured linting rules
✅ Managed third-party dependencies
✅ Generated code from your Protobuf files

Learn more

CLI Reference - Deep dive into all CLI commands
Architecture Deep-Dive - Learn about MVS dependency resolution
API Service - Set up remote code generation

On this page