Create Effect App

The create-effect-app CLI allow you to create a new Effect application using a default template or an example from a public Github repository. It is the easiest way to get started with Effect.

CLI

To begin, run the create-effect-app command in your terminal using your preferred package manager:

npm

npx create-effect-app@latest

pnpm

pnpm create effect-app@latest

Yarn

yarn create effect-app@latest

Bun

bunx create-effect-app@latest

This command starts an interactive setup that guides you through the steps required to bootstrap your project:

After making your selections, create-effect-app will generate your new Effect project and configure it based on your choices.

Example

For instance, to create a new Effect project in a directory named "my-effect-app" using the basic template with ESLint integration, you can run:

npx create-effect-app --template basic --eslint my-effect-app

Non-Interactive Usage

If you prefer, create-effect-app can also be used in a non-interactive mode:

create-effect-app
  (-t, --template basic | cli | monorepo)
  [--changesets]
  [--flake]
  [--eslint]
  [--workflows]
  [<project-name>]
create-effect-app
  (-e, --example http-server)
  [<project-name>]

Below is a breakdown of the available options to customize an Effect project template:

Option	Description
--changesets	Initializes your project with the Changesets package for managing version control.
--flake	Initializes your project with a Nix flake for managing system dependencies.
--eslint	Includes ESLint for code formatting and linting.
--workflows	Sets up Effect’s recommended GitHub Action workflows for automation.