Introduction

Overview Installation Quick Start

User Guide

Usage codify.jsonc file Plugins Editor Terminology

Commands

Developer Guide

Plugin development Quick start Core concepts Resource lifecycle Schema validation PTY abstraction Resource patterns Parameter settings Cross-platform support Testing Project structure Building and deployment Best practices API reference Examples

Plugin Development

Examples

Real-world plugin examples

Examples

See real-world examples in the default plugin repository:

Simple: Alias Resource
Multi-declaration: Aliases Resource
Stateful: Homebrew Resource
Complex: Git Repository Resource

API reference

Quick reference for classes and utilities

Common issues

A list of common issues and how to solve them

On this page