Getting started
Scaffold projects with reusable blueprints. Kano generates consistent project structures from templates, reducing setup time and enforcing best practices.
Introduction
Learn what Kano is and how it can streamline your project scaffolding.
Quick Start
Get up and running with Kano in minutes.
Blueprints
Understand how blueprints define reusable project templates.
CLI Reference
Explore all available CLI commands and options.
Quick start
Get Kano installed and create your first project from a blueprint in just a few commands.
Installation
Install Kano using Go:
go install github.com/codoworks/kano@latest
Verify the installation:
kano version
Initialize a project
Create a new project using a blueprint:
# Initialize Kano in your project directory
kano init
# Apply a blueprint to scaffold your project
kano blueprint apply go/cli my-awesome-app
What are blueprints?
Blueprints are reusable templates that define project structures, files, and configurations. They can include parameters for customization and hooks for running commands during scaffolding.
Core concepts
Kano is built around a few key concepts that make project scaffolding flexible and powerful.
Collections
Collections are groups of related blueprints. For example, you might have a "go" collection containing blueprints for CLI apps, web servers, and libraries.
Blueprints
Blueprints define the structure and files for a project template. They support parameterized templates and lifecycle hooks.
Sources
Sources define where Kano looks for blueprints: local directories, global configuration, or remote git repositories.
Getting help
Need assistance with Kano? Here are some ways to get help.
Documentation
Browse the full documentation to learn about all of Kano's features and capabilities.
GitHub Issues
Found a bug or have a feature request? Open an issue on GitHub.
Contributing
Want to contribute to Kano? Check out the contributing guide to get started.