KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #dsh #dsh-plugin #ai-agent #claude-code #codex #typescript #ai-agents #mcp #cli #rust #deepseek-harness

mkfile

★ 30 Open GitHub ↗

Full-feature ES2015+ driven task runner.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# mkfile [![NPM version](https://img.shields.io/npm/v/mkfile.svg)](https://npmjs.com/package/mkfile) [![NPM downloads](https://img.shields.io/npm/dm/mkfile.svg)](https://npmjs.com/package/mkfile) [![Build Status](https://img.shields.io/circleci/project/egoist/mkfile/1.0.svg)](https://circleci.com/gh/egoist/mkfile) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

> Task driven build tool.

Full-feature ES2015+ driven task runner.

## Install

```bash
$ npm install -g mkfile
```

## Usage

**mkfile.js** example:

```js
export function clean() {
  // clean `build` directory
  rm('-rf', './build')
}

export function build() {
  this.run('clean')
  // run webpack
  exec('./node_modules/.bin/webpack -p')
}

export default function() {
  console.log('This is the default task!')
  // call task manually
  this.run('build')
}
```

```bash
# run default task
$ mk
# run build
$ mk build
```

## CLI

```bash
$ mk -h

Task driven build tool.

Usage:
    mk [taskName]

-c/--config:     Use custom mkfile
    -l/--list:       List all task names
    -v/--version:    Print version
    -h/--help:       Print help
```

## API

### `this`

#### .run

Run a task by name.

### `global variables`

- `cli` CLI arguments parsed by [meow](https://github.com/sindresorhus/meow), the object contains `.input` and `.flags`.
- Built-in `unix shell` commands, see usage at [shelljs](https://github.com/shelljs/shelljs).

## License

mkfile

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README