Koko Koala Logo
Koko
0
Advanced

Contributing Guide

Open Source Community

Koko CLI is 100% open source under the MIT license. We actively welcome contributions including new templates, Go engine performance improvements, bug fixes, and documentation updates.

Local Development Environment Setup

Steps to clone, build, and test Koko CLI locally on your machine:

1. Clone Repository

Clone the official GitHub repository and navigate to the directory:

Terminal
git clone https://github.com/BlasVernazza06/koko-cli.git cd koko-cli

2. Run and Build in Go

Requires Go 1.21+. You can run the CLI directly from source or compile the binary:

Terminal
# Run directly from source go run main.go init # Compile binary locally go build -o koko main.go

3. Run Test Suite

Execute the automated unit and compatibility test suite:

Terminal
go test ./... -v

Go Codebase Architecture

✓ `cmd/`: Cobra CLI commands (`init.go`, `version.go`, `root.go`), Bubble Tea TUI state machine (`tui.go`), and Lipgloss views (`cmd/views/`).
✓ `internal/compatibility/`: Real-time cross-validation engine and logical safety rules.
✓ `internal/config/`: `koko.config.json` manifest builder and serializer.
✓ `internal/scaffold/`: Scaffolding engine, template handlers, and Virtual File System (`vfs`).
✓ `internal/catalog/`: Central master catalog for npm and external library package versions.
← Previous Troubleshooting Advanced Next → Frequently Asked Questions FAQ