tuist dump

Output manifest files as JSON

Overview

The tuist dump command reads a Tuist manifest file and outputs its parsed contents as JSON. This is useful for inspecting manifest structure, debugging, or integrating Tuist with other tools.

Usage

tuist dump [manifest] [options]

Arguments

manifest · string · default: "project"

The manifest type to dump. Available options:

• project - Project.swift manifest
• workspace - Workspace.swift manifest
• config - Tuist.swift configuration
• template - Template.swift manifest
• plugin - Plugin.swift manifest
• package - Package.swift settings

Options

--path · string · default: "."

The path to the folder where the manifest is located.

-p · string

Short form of --path.

Examples

Dump project manifest

tuist dump

Outputs the Project.swift manifest as JSON to stdout.

Dump workspace manifest

tuist dump workspace

Outputs the Workspace.swift manifest as JSON.

Dump configuration

tuist dump config

Outputs the Tuist.swift configuration file as JSON.

Dump with custom path

tuist dump project --path ~/Projects/MyApp

Dumps the project manifest from a specific directory.

Dump template

tuist dump template --path Templates/Feature

Outputs a template manifest as JSON.

Dump plugin manifest

tuist dump plugin --path Plugins/MyPlugin

Outputs a plugin manifest as JSON.

Dump package settings

tuist dump package

Outputs Package.swift dependency configuration as JSON.

Output format

The command outputs well-formatted JSON to stdout. The structure matches the internal representation of the manifest after parsing, including:

• Target configurations
• Dependencies
• Build settings
• Schemes
• File references
• And all other manifest properties

Use cases

Debugging manifests

Inspect how Tuist interprets your manifest files:

tuist dump project | jq '.targets[] | .name'

Integration with tools

Parse manifest data in scripts or external tools:

tuist dump project > project.json
node analyze-project.js

Validating configuration

Verify that your manifest is parsed correctly:

tuist dump config | jq '.plugins'

Extracting specific data

Use with jq or other JSON tools to extract specific information:

# List all target names
tuist dump project | jq '.targets[].name'

# Get all external dependencies
tuist dump project | jq '.packages[].url'

# Check build settings for a target
tuist dump project | jq '.targets[] | select(.name=="App") | .settings'

The dump command loads and evaluates the manifest, so it will fail if the manifest contains errors or invalid configuration.

Related

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