crust

<h1 align="center"> <img src="assets/crust-logo.png" alt="Crust logo" width="120"> <br> Crust </h1> <p align="center">A TypeScript CLI framework with composable modules for humans and agents.</p> <p align="center"> <a href="https://github.com/chenxin-yan/crust/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@crustjs/crust" alt="license"></a> <a href="https://github.com/chenxin-yan/crust"><img src="https://img.shields.io/github/stars/chenxin-yan/crust" alt="stars"></a> </p> <p align="center"> <a href="https://crustjs.com">Website & Docs</a> <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> <a href="./CONTRIBUTING.md">Contributing</a> <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> <a href="https://github.com/chenxin-yan/crust/issues">Issues</a> <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> <a href="https://discord.gg/sQF8hdN6Ht">Discord</a> </p> ## What is Crust? Crust is a TypeScript CLI framework for humans and agents. Define a command once with full type inference, and it runs as a CLI, packages as an agent skill, and can be exposed over MCP. Composable modules add prompts, progress, TUI, styling, persistence, man pages, and testing helpers as you need them. It runs on Bun, Node.js, and Deno, with native Bun integrations. ## Who uses Crust? - [gyst](https://github.com/chenxin-yan/gyst) - [Nia](https://github.com/nozomio-labs/nia-cli) by [Nozomio Labs](https://www.trynia.ai/) ## Getting Started ### Bun ```sh bun create crust@latest my-cli cd my-cli bun run dev ``` ### npm ```sh npm create crust@latest my-cli cd my-cli npm run dev ``` ### pnpm ```sh pnpm create crust@latest my-cli cd my-cli pnpm run dev ``` ### Yarn (2+) ```sh yarn dlx create-crust@latest my-cli cd my-cli yarn run dev ``` ### Deno ```sh deno run -A npm:create-crust@latest my-cli --runtime deno cd my-cli deno task dev ``` ## Packages | Package | Description | Version | Downloads | | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | [`@crustjs/crust`](https://www.npmjs.com/package/@crustjs/crust) | CLI to build and publish Crust apps as npm packages or standalone binaries | [](https://www.npmjs.com/package/@crustjs/crust) | [](https://www.npmjs.com/package/@crustjs/crust) | | [`@crustjs/core`](https://www.npmjs.com/package/@crustjs/core) | Define, parse, route, and run type-safe CLI commands with Contexts and Extensions | [](https://www.npmjs.com/package/@crustjs/core) | [](https://www.npmjs.com/package/@crustjs/core) | | [`@crustjs/man`](https://www.npmjs.com/package/@crustjs/man) | Generate mdoc(7) manual pages from Crust command definitions | [](https://www.npmjs.com/package/@crustjs/man) | [](https://www.npmjs.com/package/@crustjs/man) | | [`@crustjs/testing`](https://www.npmjs.com/package/@crustjs/testing) | Test helpers for Crust CLIs with captured output and fake interactive terminals | [](https://www.npmjs.com/package/@crustjs/testing) | [](https://www.npmjs.com/package/@crustjs/testing) | | [`@crustjs/extensions`](https://www.npmjs.com/package/@crustjs/extensions) | Official Crust Extensions for help, version, completion, typo hints, color, and updates | [](https://www.npmjs.com/package/@crustjs/extensions) | [](https://www.npmjs.com/package/@crustjs/extensions) | | [`@crustjs/style`](https://www.npmjs.com/package/@crustjs/style) | Terminal styling, colors, hyperlinks, and ANSI-aware text layout | [](https://www.npmjs.com/package/@crustjs/style) | [](https://www.npmjs.com/package/@crustjs/style) | | [`@crustjs/progress`](https://www.npmjs.com/package/@crustjs/progress) | Spinners and determinate progress indicators for terminal tasks | [](https://www.npmjs.com/package/@crustjs/progress) | [](https://www.npmjs.com/package/@crustjs/progress) | | [`@crustjs/prompts`](https://www.npmjs.com/package/@crustjs/prompts) | Interactive input, password, confirm, select, and filter prompts for the terminal | [](https://www.npmjs.com/package/@crustjs/prompts) | [](https://www.npmjs.com/package/@crustjs/prompts) | | [`@crustjs/tui`](https://www.npmjs.com/package/@crustjs/tui) | Bun-only OpenTUI renderer adapter for Crust Command Actions | [](https://www.npmjs.com/package/@crustjs/tui) | [](https://www.npmjs.com/package/@crustjs/tui) | | [`@crustjs/effect`](https://www.npmjs.com/package/@crustjs/effect) | Effect.ts v4 adapter for Crust Command Actions, Contexts, and errors | [](https://www.npmjs.com/package/@crustjs/effect) | [](https://www.npmjs.com/package/@crustjs/effect) | | [`@crustjs/env`](https://www.npmjs.com/package/@crustjs/env) | Typed, validated environment variables as a Crust Context, documented in help and man pages | [](https://www.npmjs.com/package/@crustjs/env) | [](https://www.npmjs.com/package/@crustjs/env) | | [`@crustjs/store`](https://www.npmjs.com/package/@crustjs/store) | Typed JSON persistence for CLI config, data, state, and cache files | [](https://www.npmjs.com/package/@crustjs/store) | [](https://www.npmjs.com/package/@crustjs/store) | | [`@crustjs/skills`](https://www.npmjs.com/package/@crustjs/skills) | Generate and install agent skills for AI coding assistants from Crust commands | [](https://www.npmjs.com/package/@crustjs/skills) | [](https://www.npmjs.com/package/@crustjs/skills) | | [`@crustjs/mcp`](https://www.npmjs.com/package/@crustjs/mcp) | Serve a Crust CLI as MCP tools over stdio | [](https://www.npmjs.com/package/@crustjs/mcp) | [](https://www.npmjs.com/package/@crustjs/mcp) | | [`@crustjs/create`](https://www.npmjs.com/package/@crustjs/create) | Headless scaffolding engine for building project generators | [](https://www.npmjs.com/package/@crustjs/create) | [](https://www.npmjs.com/package/@crustjs/create) | | [`create-crust`](https://www.npmjs.com/package/create-crust) | Scaffold a new Crust CLI project for Bun, Node.js, or Deno | [](https://www.npmjs.com/package/create-crust) | [](https://www.npmjs.com/package/create-crust) |