# create-japa

> Setup japa inside an existing Node.js project

Latest version **2.2.3** (published 2025-12-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install create-japa
pnpm add create-japa
yarn add create-japa
bun add create-japa
```

Provides the command `create-japa`.

## Health

**Score 55/100 (C)** — status: stable.

Positive: esm support; no vulnerabilities; has provenance.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 2.2.3 |
| Published | 2025-12-26 |
| First published | 2022-02-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=20.9.0 |
| Dependencies | 5 |
| Unpacked size | 19.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 6 |
| Author | Harminder Virk |
| Maintainers | romainlanz, virk, julien-r44 |
| Keywords | japa, init |

## Links

- npm: https://www.npmjs.com/package/create-japa
- Repository: https://github.com/japa/create-japa
- Homepage: https://github.com/japa/create-japa#readme
- Issues: https://github.com/japa/create-japa/issues
- npm.io page: https://npm.io/package/create-japa

## Dependencies (5)

- [edge.js](https://npm.io/package/edge.js.md) ^6.3.0
- [@adonisjs/ace](https://npm.io/package/@adonisjs/ace.md) ^14.0.1-next.3
- [which-pm-runs](https://npm.io/package/which-pm-runs.md) ^1.1.0
- [gradient-string](https://npm.io/package/gradient-string.md) ^3.0.0
- [@antfu/install-pkg](https://npm.io/package/@antfu/install-pkg.md) ^1.1.0

## Recent versions

- 2.2.3 (latest) — 2025-12-26
- 2.0.0-3 (next) — 2023-09-26
- 2.2.2 — 2025-12-26
- 2.2.1 — 2025-12-13
- 2.2.0 — 2025-07-21
- 2.1.4 — 2025-01-14
- 2.1.3 — 2024-09-14
- 2.1.2 — 2024-04-29
- 2.1.1 — 2024-04-07
- 2.1.0 — 2023-12-18
- 2.0.0 — 2023-10-07
- 1.2.2 — 2023-10-07
- 1.2.1 — 2023-10-07
- 2.0.0-2 — 2023-07-10
- 2.0.0-1 — 2023-07-10
- … 16 more at https://npm.io/package/create-japa/versions

## README

# create-japa
> Setup japa inside an existing Node.js app

[![github-actions-image]][github-actions-url] [![npm-image]][npm-url] [![license-image]][license-url] [![typescript-image]][typescript-url]

![](./japa_art.png)

The `create-japa` is a CLI utility to configure Japa inside a new or existing Node.js project.

The process involves installing the required packages and creating the necessary files. The setup works with Typescript and JavaScript projects.

## Usage
Navigate to the root of your project and run the following command.

```sh
npm init japa
```

```sh
yarn create japa
```

```sh
pnpm create japa
```

## Options

### `destination (optional)`

You can pass the destination directory as the first argument to the command. The `process.cwd()` will be used when the option is not defined.

```sh
npm init japa my-app
```

### `--package-manager`

Define the package manager to use to install dependencies. If not defined, we will attempt to detect the package manager using [@antfu/install-pkg
](https://github.com/antfu/install-pkg) package.

```sh
npm init japa -- --package-manager=pnpm
```

### `--plugins`
Define an array of plugins to install. We will display a series of prompts if this flag is not set.

```sh
npm init japa -- --plugins="@japa/api-client" --plugins="@japa/snapshot"
```

### `--project-type`
Define the project type for which you want to configure Japa. The value could be either `typescript` or `javascript`. If this flag is not set, we will display a prompt for the project type selection.

```sh
npm init japa -- --project-type=typescript
```

### `--sample-test-file`
Enable the flag to create a sample test file or disable it not to create it.

```sh
# Enable it
npm init japa -- --sample-test-file

# Disable it
npm init japa -- --no-sample-test-file
```

[github-actions-image]: https://img.shields.io/github/actions/workflow/status/japa/create-japa/checks.yml?style=for-the-badge
[github-actions-url]: https://github.com/japa/create-japa/actions/workflows/checks.yml "github-actions"

[npm-image]: https://img.shields.io/npm/v/create-japa.svg?style=for-the-badge&logo=npm
[npm-url]: https://npmjs.org/package/create-japa "npm"

[license-image]: https://img.shields.io/npm/l/create-japa?color=blueviolet&style=for-the-badge
[license-url]: LICENSE.md "license"

[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
[typescript-url]:  "typescript"

---
_Source: https://npm.io/package/create-japa · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._