@kitschpatrol/create-project
v1.11.0
Published
Kitschpatrol's TypeScript project templates.
Maintainers
Readme
@kitschpatrol/create-project
Kitschpatrol's TypeScript project templates.
Overview
This repository contains very basic starter templates for TypeScript projects integrating @kitschpatrol/shared-config.
The lint tools and rules that come along with @kitschpatrol/shared-config are opinionated and draconian, and won't be to everyone's taste.
The templates use tsdown for building TypeScript libraries and Node-based CLI tools, and Vite for web projects. Bingo is used for the project templating system itself.
Nine template types are available:
| Template | Description |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| minimal | Bare TypeScript scratch project, run with tsx — no build step. |
| web | Vite web app with Vitest tests, deployed to Cloudflare Workers with Wrangler. |
| cli | Node.js command-line tool using yargs, bundled with tsdown for publication to npm. |
| library | ESM npm library with type declarations, bundled with tsdown. |
| cli+library | ESM library built for a neutral platform and npm-installed Node.js CLI, with separate builds and an optional shared Node.js build. |
| lit | Single Lit web component published as an ESM npm package, with a Vite development playground. |
| electron | Electron app using vite-plugin-electron and electron-builder. |
| electron+node | Electron app with Node-targeted main and preload builds via electron-vite (using the @kitschpatrol/electron-vite fork) and electron-builder. |
| unplugin | Universal bundler plugin via unplugin, targeting Vite, Rollup, Rolldown, webpack, Rspack, esbuild, Farm, and Bun. |
Getting started
Dependencies
- Node.js 24.16.0 or newer (specifically
^24.16.0 || >=26.3.0)
Development dependencies
- pnpm 12.10.1
Generated projects declare their runtime requirements in engines or
devEngines, depending on the template. Check the generated package.json
for its requirements.
Agent skills
pnpm install runs skills experimental_sync -y -f through the prepare
script in this repository and every generated project. This syncs skills from
installed dependencies; run pnpm prepare to refresh them. Generated agent
directories and skills-lock.json are ignored by Git.
Usage
Create a new project
pnpm create @kitschpatrol/project@latestIf you have pnpm's minimumReleaseAge option enabled, you might need to disable it if you trust this repository and really want the latest latest:
pnpm --config.minimum-release-age=0 create @kitschpatrol/project@latestCLI options
Bingo template options:
--directory (string): What local directory path to run under
npx @kitschpatrol/create-project --directory my-fancy-project
--help (boolean): Prints help text.
npx @kitschpatrol/create-project --help
--mode ("setup" | "transition"): Which mode to run in.
npx @kitschpatrol/create-project --mode setup
npx @kitschpatrol/create-project --mode transition
--offline (boolean): Whether to run in an "offline" mode that skips network requests.
npx @kitschpatrol/create-project --offline
--owner (string): What GitHub organization or user the repository will be under.
npx @kitschpatrol/create-project --owner my-org
--remote (boolean): Whether to create a remote repository on GitHub if one does not already exist.
npx @kitschpatrol/create-project --remote
--repository (string): What the repository will be named.
npx @kitschpatrol/create-project --repository my-fancy-project
--skip-files (boolean): Whether to skip creating files on disk.
npx @kitschpatrol/create-project --skip-files
--skip-requests (boolean): Whether to skip sending network requests as specified by templates.
npx @kitschpatrol/create-project --skip-requests
--skip-scripts (boolean): Whether to skip running local scripts as specified by templates.
npx @kitschpatrol/create-project --skip-scripts
--version (boolean): Prints package versions.
npx @kitschpatrol/create-project --version
Create Kitschpatrol Project options:
--type ("minimal" | "web" | "cli" | "library" | "cli+library" | "lit" | "electron" | "electron+node" | "unplugin"): The type of project to create.
--author-name (string): The name of the author.
--author-email (string): The email of the author.
--author-url (string): The URL of the author.
--cli-command-name (string): CLI command name (if applicable).
--github-owner (string): The owner of the repository.
--github-repository (string): The name of the repository / package.
--npm-token-command (string): A shell command that returns a granular token for publishing to the npm registry.
--npm-otp-command (string): A shell command that returns a one-time password for publishing to the npm registry.npm Publishing configuration
I publish most of my packages via a local command instead of through CI.
Most template projects include a release script for this purpose.
Two credentials are passed at the last minute to the pnpm publish command in the release script. The template must define how to fetch these.
npm token
As of November 2025, granular access tokens are required for publishing packages to npm.
The default --npm-token-command template value expects you to have the 1Password CLI installed, npm access token configured and stored at a specific path in 1Password, and for your global configuration to look a certain way.
This requires some one-time global configuration on the deploy machine. pnpm expands the NPM_TOKEN environment variable in this trusted user configuration when publishing.
pnpm config set '//registry.npmjs.org/:_authToken' '${NPM_TOKEN}'Check who pnpm thinks you are to confirm everything works:
NPM_TOKEN=$(op read 'op://Personal/npm/token') pnpm whoaminpm one-time password
As of August 2026, 2fa is required alongside the token for publishing packages to npm.
The default --npm-otp-command template value expects you to have the 1Password CLI installed, with your npm OTP configured and stored at a specific path in 1Password.
Development Notes
Build and run the CLI locally:
pnpm build
./dist/index.js --directory ~/Desktop/testUpdate dependencies in every template:
pnpm update-templatesTemplate READMEs keep their MDAT placeholders unexpanded until project generation,
when pnpm fix expands them using the generated package metadata. Run pnpm fix
after changing that metadata or updating MDAT.
The templates are pnpm workspace members of this repository, so they are linted (with their own eslint.config.ts files) by the root pnpm lint. Lint rule overrides between Template-dev-only markers silence placeholder-value errors during template development and are stripped from generated projects.
Maintainers
Acknowledgments
Thanks to Josh Goldberg for creating the Bingo template system.
Contributing
Issues are welcome and appreciated.
Please open an issue to discuss changes before submitting a pull request. Unsolicited PRs (especially AI-generated ones) are unlikely to be merged.
This repository uses @kitschpatrol/shared-config (via its ksc CLI) for linting and formatting, plus MDAT for readme placeholder expansion.
