Getting Started

lyt

Install lyt, create a project, and build your first site in under 5 minutes.

Installation

Install with Go

The fastest way:

go install github.com/b7r-dev/lyt@latest

Clone the repo and use the Makefile:

git clone https://github.com/b7r-dev/lyt
cd lyt
sudo make install

This installs lyt to /usr/local/bin on macOS and Linux.

Verify Installation

lyt --version

You should see: lyt 0.2.0

Using lyt

Two Ways to Run lyt

Globally Installed

After sudo make install or go install, run from any directory:

lyt init my-site
cd my-site
lyt build

Development (Working in the lyt Repo)

If you're working on lyt itself or want the latest changes:

cd lyt
go run . build -o ./dist

This runs lyt directly from source without installing it.

Project Structure

The Content/Style/Engine Split

lyt keeps three things strictly separate:

Directory Purpose Contains
content/ Your content YAML pages, blog posts, config
templates/ Your design HTML, CSS
cmd/, internal/ The tool Go code (shared across sites)

This means the same engine can build many different sites—swap out content and templates, and you have a completely different site.

Create a New Project

Quick Start

mkdir my-site
cd my-site
lyt init

This creates:

my-site/
├── content/
│   ├── pages/
│   │   ├── index.yaml
│   │   ├── about.yaml
│   │   └── components.yaml
│   ├── blog/
│   │   └── hello-world.yaml
│   ├── config/
│   │   └── site.yaml
│   └── tokens.yaml
├── templates/
│   └── base.css
└── public/

Learn about project structure →

Build Your Site

Build Command

lyt build

This generates your site in ./dist/:

dist/
├── index.html
├── about.html
├── components.html
├── blog/
│   └── hello-world/
│       └── index.html
├── base.css
├── tokens.css
└── sitemap.xml

Preview

lyt serve

Opens http://localhost:8080 with live reload on file changes.

Validate Your Content

lyt includes content validation:

lyt validate          # Check content validity
lyt build --validate  # Build with automatic validation

The schema is in content/schema.yaml.

Start with an AI Agent

Let an AI Build Your Site

Copy this prompt and paste it into VS Code (Copilot), Cursor, Codex, Auggie, or any AI coding assistant:

I want to create a static site using lyt (https://github.com/b7r-dev/lyt). 

1. First, install lyt globally: go install github.com/b7r-dev/lyt@latest
2. Create a new project: mkdir my-site && cd my-site && lyt init
3. Customize the content/pages/index.yaml to change the hero title to "My Awesome Site"
4. Add a new page at content/pages/about.yaml with a simple hero
5. Build the site: lyt build
6. Open dist/index.html in a browser to verify it works

Please run these commands and show me the results.

The AI will install lyt, create a project, customize it, and build it—all from your prompt.

Next Steps

Now that you have a site, learn how to add content and customize.

Content Guide