crystal-init(1)

crystal-init1

Create a a new crystal project

Usage

crystal init TYPE [{DIR | NAME DIR}]

Overview

TYPE is one of:

lib Creates a library skeleton
app Creates an application skeleton

This initializes the lib/app project folder as a git repository, with a license file, a README file, a shard.yml for use with shards (the Crystal dependency manager), a .gitignore file, and src and spec folders.

DIR - directory where project will be generated

NAME - name of project to be generated (default: basename of DIR)

Options

-f, --force

Force overwrite existing files.

-s, --skip-existing

Skip existing files.

From crystal 1.22.2-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.