teakit
v0.2.0
Published
CLI for Teakit: create and check tslib projects, and extract editable component source from installed source packages.
Readme
teakit
Copy component source from an installed package into your project, and own it from there.
A source package is any package that ships a registry/ built with
@teakit/registry. teakit never goes online,
installs dependencies, or changes package.json, lockfiles or node_modules. Requires Node 26.12
or later.
npm install --save-dev teakitUse components
teakit init # find installed source packages and write teakit.json
teakit list # list the families
teakit view card # files, requirements and README of a family
teakit add card # copy card and its dependencies into src/composites/
teakit add card --diff # preview without writing
teakit info # project state; works before initadd creates missing files, skips identical ones and asks before replacing one that differs. Pass
-o to allow replacements. teakit.json is the only file teakit keeps:
{
"sources": ["@yiplex/aster"],
"framework": "astro",
"composites": "src/composites",
"css": "src/styles/global.css"
}Build a source package
teakit create ui --template source-react # or source-astro
teakit registry build # write registry/
teakit registry audit # registry/ matches the sources
teakit registry check ui-1.0.0.tgz # the packed tarball matches too
teakit doctor # check the packageteakit create <name> without --template starts a TypeScript library instead.
Automation
Pass --json to get one result object on stdout. Exit codes are 0 for success, 1 for a
failure, 2 for invalid input and 130 for a cancelled prompt. teakit --describe prints every
command, option and code as JSON, and skills/ in the package documents them for coding agents.
License
MIT © Teakit.org. Component source that you copy keeps the license of its package.
