Overview#

playbooks.json is the small, source-controlled identity contract between a project and Playbooks. Keep it at the repository root.

The manifest gives Playbooks a portable name and description for the project. Playbooks manages presentation, visibility, deployment, credentials, infrastructure, and runtime configuration outside the repository contract.

Configuration#

{
	"$schema": "https://playbooks.ai/schemas/project.json",
	"version": 1,
	"name": "My Project",
	"tagline": "A short project summary",
	"description": "Describe what this project does."
}

version, name, and description are required. $schema and tagline are optional. Additional properties are not accepted.

Platform Configuration#

Manage visibility, thumbnails, covers, deployment preferences, credentials, and secrets in Playbooks. Do not add those values—or runtime details such as images, commands, ports, Dockerfiles, Compose configuration, networks, volumes, dependencies, or service graphs—to playbooks.json.

When importing a project, Playbooks inspects its existing package scripts, Dockerfiles, Compose files, services, and health checks separately. These files inform private runtime configuration without expanding the identity manifest.

Existing manifests that include unsupported configuration must be narrowed to the documented identity fields before Playbooks accepts them.