Skip to content

autosergach/archkit

Repository files navigation

archkit

Clean Architecture project generator for TypeScript. Scaffold libraries (v0.1) and full-stack apps (v0.2+) with sensible defaults, working tests, and AI-friendly structure.

npm CI license

Quick start

npx @autosergach/archkit create my-lib
cd my-lib
pnpm install
pnpm test

Tip: install once globally for the short archkit command everywhere:

npm install -g @autosergach/archkit
archkit create my-lib

You get a TypeScript library with:

  • ES2022, NodeNext modules, strict TypeScript
  • vitest for tests
  • eslint flat config with typescript-eslint
  • Clean Architecture skeleton: domain/, application/, ports/
  • A working example use case (createUser) with passing tests

Commands

archkit create [project-name]      # scaffold a new project
archkit create my-lib --dry-run    # preview without writing files
archkit create my-lib --out ./libs # custom output directory
archkit --help
archkit --version

Options

Flag Default Description
--out <dir> . Where to create the project directory
--package-name <name> (project name, kebab-cased) npm name field
--skip-install Skip the "run pnpm install?" prompt
--dry-run Print planned actions without writing files

Templates

library-clean (default in v0.1)

TypeScript library with Clean Architecture layout:

my-lib/
├── src/
│   ├── domain/        # entities, value objects, errors
│   ├── application/   # use cases (depend on ports)
│   ├── ports/         # interfaces for external dependencies
│   └── index.ts       # public API barrel
├── tests/             # vitest unit tests
├── package.json
├── tsconfig.json
├── vitest.config.ts
└── eslint.config.js

Roadmap

  • ✅ v0.1.0 — library-clean template, archkit create command, --dry-run
  • 🚧 v0.2.0 — NestJS+React fullstack template, --ai-ready flag (autogen CLAUDE.md, .claude/settings.json, agents.md)
  • 🚧 v0.3.0 — Plugin system for custom templates

Contributing

See docs/architecture.md for how the codebase is organized.

git clone https://github.com/autosergach/archkit.git
cd archkit
pnpm install
pnpm -r build
pnpm -r test
pnpm test:e2e

License

MIT © Alex Rogov

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors