lyrn adopt

$ lyrn adopt [path] [options]

Adds the files of the line’s standard that an existing repository does not have yet, and never touches the ones it does. What it adds is the part of the standard every repository carries whatever its code does:

File	What it is
README.md	The shopfront
LICENSE	MIT, in the author’s name
CHANGELOG.md, cliff.toml	A changelog generated from Conventional Commits
.editorconfig, .gitattributes, .gitignore	How files are written and kept
.github/workflows/ci.yml	The gate the form runs: lint, types, tests, build
.github/workflows/audit.yml	Published advisories and licenses, on every push and every Monday
.github/workflows/shopfronts.yml	lyrn check on every push: the README, the manifests and the site agree
.github/ISSUE_TEMPLATE/, .github/pull_request_template.md	Reports and changes arrive with what is needed to act on them
SECURITY.md, CODE_OF_CONDUCT.md	Where a vulnerability is reported, and how people treat each other
docs/adr/0001-record-architecture-decisions.md, 0002-dependabot-is-off.md, README.md	The decision log, started
rustfmt.toml, deny.toml	The line’s formatting, and what the audit holds crates to - for the Rust forms
lyrn.toml	What the project is, and the version of the standard it carries, for doctor and upgrade to read

The release contour - release and publish workflows, the npm wrapper, the installers - is part of the standard too, but its files only work together and against one package layout, so they are not added one by one beside a build lyrn did not make. CONTRIBUTING.md and llms.txt describe the repository’s own layout and gate, which a form’s version would get wrong, so they are not added either.

What it reads

The repository describes itself, and adopt listens before it assumes:

• The form comes from lyrn.toml if there is one, else from what the repository holds: src-tauri/ is a desktop, a Cargo [workspace] a workspace, a crate on tauri-plugin a tauri-plugin, one on axum a service, a crate named kilna-plugin-* a plugin for kilna, any other binary crate a cli, a pnpm workspace with packages/ a mono, and a package on Vite a spa. Anything else is refused with the forms on offer, rather than adopted as a guess - a library crate among them.
• The name and the description come from Cargo.toml or package.json; the name falls back to the directory’s.
• The repository is the GitHub remote origin points at.
• The accent is the product’s own when the project is a product of the line - hilvan is crimson without being told.

Anything given on the command line wins.

What is already there

A file of the standard counts as present under its own name or under one it is commonly kept under: LICENSE.md or COPYING for the licence, CHANGES.md for the changelog, ci.yaml for the gate. The decision log is adopted whole or not at all: a repository that keeps decisions of its own in docs/adr/ gets none of the standard’s, since a second 0001 would make “ADR 1” mean two things and an index written for the standard’s decisions would list its own wrongly. The tree shown before writing says which files are kept and why:

$ lyrn adopt --dry-run
Would add 19 files to `.` as a `cli` project; 3 of its standard are already there:

  ├── .github/
  │   ├── ISSUE_TEMPLATE/
  │   │   ├── bug_report.yml
  │   │   ├── config.yml
  │   │   └── feature_request.yml
  │   ├── workflows/
  │   │   ├── audit.yml
  │   │   ├── ci.yml
  │   │   └── shopfronts.yml
  │   └── pull_request_template.md
  ├── docs/
  │   └── adr/
  │       ├── 0001-record-architecture-decisions.md
  │       ├── 0002-dependabot-is-off.md
  │       └── README.md
  ├── .editorconfig
  ├── .gitattributes
  ├── .gitignore  (already there)
  ├── CHANGELOG.md
  ├── CODE_OF_CONDUCT.md
  ├── LICENSE  (`LICENSE.md` is there)
  ├── README.md  (already there)
  ├── SECURITY.md
  ├── cliff.toml
  ├── deny.toml
  ├── lyrn.toml
  └── rustfmt.toml

Running it again has nothing to add. adopt stages and commits nothing: the repository is yours, and git status shows what arrived.

A documentation site is something a repository has rather than something it is, so it is not adopted; lyrn adopt says when there is none, and lyrn new <name> --form docs adds one.

Options

Option	Default	What it does
[path]	.	The repository to adopt
--form <form>	read from the repository	The form it has
--host <host>	read from a plugin’s name	The application a plugin extends
--name <name>	from its manifest	The project name
--accent <colour>	its own, else asked	A product of the line, or a #rrggbb value
--description <text>	from its manifest	One line describing what the project is
--author <name>	the global git config user.name	Recorded in LICENSE
--repo <owner/name>	the origin remote	The GitHub repository it lives in
-y, --yes	—	Accept the defaults instead of asking
--dry-run	—	Show what would be added and kept, and write nothing