Getting Started

Everything you need to know to go from zero to a fully orchestrated developer workflow with EZKeel.

What is EZKeel?

EZKeel is an AI-native dev platform orchestrator. It unifies three powerful tools into one coherent workflow, all driven by a single configuration file:

Instead of configuring each tool separately, you declare everything in a workspace.yaml file and let the ezkeel CLI wire it all together.

Quick Start

Get up and running in four steps.

1

Install the CLI

Build from source using Go:

terminal
$ go install github.com/ezkeel/ezkeel/cmd/ezkeel@latest
2

Deploy the Platform

Install Forgejo, Infisical, and all supporting services on your VPS:

terminal
$ ezkeel platform install \ --forgejo-domain git.example.com \ --infisical-domain secrets.example.com EZKeel platform installed at /opt/ezkeel Forgejo: https://git.example.com Infisical: https://secrets.example.com
3

Create a Project

Initialize a new project with a scaffolded workspace.yaml, dev container config, and AI persona:

terminal
$ ezkeel init my-project \ --forgejo-url https://git.example.com \ --forgejo-token $FORGEJO_TOKEN Created repository: https://git.example.com/org/my-project.git created workspace.yaml created CLAUDE.md created AGENTS.md created .devcontainer/devcontainer.json Project "my-project" initialized at /home/dev/my-project
4

Start Coding

Inject your secrets and launch an AI tool with a single command:

terminal
$ cd my-project $ eval $(ezkeel secrets inject dev) $ ezkeel ai claude "set up the project structure"

Core Concepts

workspace.yaml

The single configuration file that drives everything. It defines your project's visibility rules, secrets requirements, AI model configuration, CI setup, and deployment. See the full schema reference.

Visibility

EZKeel gives you fine-grained control over what code is public and what stays private. You define public_paths and private_paths in your workspace, and use ezkeel publish to mirror only public content to an open-source repository. See Visibility.

Secrets

Secrets are managed through Infisical and declared in your workspace.yaml. EZKeel injects them into your shell or passes them directly to AI tools. No more .env files scattered across machines. See Secrets.

AI Persona

Each project gets a .claude/ directory containing AI configuration — model preferences, MCP servers, and a persona prompt. The ezkeel sync push/pull commands keep this persona consistent across machines via a dedicated Git branch. See AI Configuration.

Next step: Follow the Installation guide for detailed setup instructions, or jump to the CLI Reference if you are ready to explore commands.