Getting Started

lyrn creates a repository that is ready to work in: Vite, React, TypeScript, Tailwind and the dowel design system, plus the things a project usually grows only after the third time somebody wishes it had them — a CI gate, a changelog, an ADR directory, an editor config.

Install

$ npm install -g lyrn

Or with cargo:

$ cargo install lyrn

Or without a package manager at all:

$ curl -fsSL https://raw.githubusercontent.com/lacodda/lyrn/main/tools/install.sh | sh

irm https://raw.githubusercontent.com/lacodda/lyrn/main/tools/install.ps1 | iex

Create a project

$ lyrn new demo-app --accent kilna
Created 44 files in `demo-app`.
Installing dependencies... done
Starting the repository... done
Staging the first commit... done
Creating the first commit... done

Next:
  cd demo-app
  pnpm dev

The project is already a git repository with one Conventional Commit in it, its dependencies are installed, and pnpm dev runs.

Check it

$ cd demo-app
$ pnpm lint

That single script is eslint, tsc --noEmit and the tests — the same gate the generated .github/workflows/ci.yml runs. A green terminal means a green pull request.

See it first

Nothing has to be written to find out what would be:

$ lyrn new demo-app --dry-run
Would create 44 files in `demo-app`:

  ├── .github/
  │   ├── ISSUE_TEMPLATE/
  │   │   ├── bug_report.yml
  │   │   ├── config.yml
  │   │   └── feature_request.yml
  │   ├── workflows/
  │   │   ├── audit.yml
  │   │   └── ci.yml
  │   └── pull_request_template.md
  ├── assets/
  ...

Answer nothing

With a terminal attached lyrn asks for what it is missing. In a script or in CI there is nobody to ask, so it takes the defaults and never blocks:

$ lyrn new demo-app --yes