tuist init

Get started with Tuist in your project

Overview

The tuist init command helps you bootstrap a new Tuist project or add Tuist to an existing project. It guides you through an interactive setup process to configure your project structure.

Usage

tuist init [options]

Options

--path · string · default: "."

The path to the directory from where to start. Defaults to the current directory.

-p · string

Short form of --path.

Examples

Initialize in current directory

tuist init

This will start an interactive prompt to set up Tuist in your current directory.

Initialize in a specific directory

tuist init --path ~/MyProject

Sets up Tuist in the specified directory.

What it does

The tuist init command:

1. Analyzes your current project structure
2. Prompts you for project configuration preferences
3. Generates the necessary manifest files (Project.swift, Workspace.swift, etc.)
4. Creates a recommended project structure

Next steps

After initializing your project:

Generate

Generate an Xcode workspace from your manifests

Build

Build your project with Tuist

Related

• Project.swift reference
• Tuist.swift reference
• Workspace.swift reference