https://github.com/rajatsandeepsen/mcmd
A meta framework for building CLI
https://github.com/rajatsandeepsen/mcmd
cli mcmd zod
Last synced: 4 months ago
JSON representation
A meta framework for building CLI
- Host: GitHub
- URL: https://github.com/rajatsandeepsen/mcmd
- Owner: rajatsandeepsen
- Created: 2025-06-24T00:50:54.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-06-24T09:51:20.000Z (4 months ago)
- Last Synced: 2025-06-24T10:46:01.593Z (4 months ago)
- Topics: cli, mcmd, zod
- Language: TypeScript
- Homepage: https://npmjs.com/package/mcmd
- Size: 4.88 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MCMD - A Meta framework for building CLIs
Enjoy the DX of File Based Routing (eg: NextJs) for CLI development.
### Usage
Install [MCMD package](https://npmjs.com/package/mcmd) from NPM
Or clone the ready-made template from [MCMD github](https://github.com/rajatsandeepsen/create-mcmd-app) repository
```bash
bun create mcmd-app --name my-cli
```
```bash
npx create mcmd-app --name my-cli
```
> [!WARNING]
> MCMD plugin isn't available on node.js right now. Make sure to use Bun for building the CLI
### Folder Structure
```
root
├── .mcmd
├── node_modules
│
├─┬ app
│ ├── index.ts # npx my-cli
│ ├─┬ init
│ │ ├── something.ts # npx my-cli init something
│ │ └── index.ts # npx my-cli init
│ └── login.ts # npx my-cli login
│
├── package.json
├── build.ts
├── .gitignore
├── README.md
└── tsconfig.json
```
### Coding
Don't need to import `zod` or `Command`, we'll handle everything for you.
```ts
// app/index.ts
export const options = z.object({
name: z.string()
});
export default Command((data) => {
const { name } = data;
console.log("Hi", name);
});
// npx my-cli --name Rajat
```
```ts
// app/init.ts
export default () => {
console.log("Done Init");
};
// npx my-cli init
```
### Final Build
```bash
bun run build
# or
# bunx mcmd build
```
### Publish CLI
```json
// package.json
{
"name": "my-cli",
"version": "0.0.0",
"bin": "./dist/cli.js",
"files": ["dist/**/*"],
...
}
```
```bash
bun publish
```
### Enjoy CLI
```bash
bunx my-cli --name Rajat
```
### TypeScript Support
Extends you `tsconfig.json` with `mcmd/base.json`
```json
{
// tsconfig.json
compilerOptions: {},
"include": ["."],
"exclude": [
"dist",
"node_modules"
],
"extends": [
"mcmd/base.json" // important
]
}
```
Or paste this code to `./type.d.ts`
```ts
// Don't remove this.
// This helps for automatic type assigning for MCMD.
///
```
Follow this code to get full TypeScript support
```ts
// app/index.ts
export const options = z.object({
name: z.string()
});
export default Command((data) => {
const { name } = data;
console.log("Hi", name);
});
```