Back to Tuist

CLI {#cli}

server/priv/docs/en/cli/index.md

4.191.81.0 KB
Original Source

CLI {#cli}

The Tuist CLI is one of the interfaces for interacting with Tuist, and the most common one if you are using <.localized_link href="/guides/features/projects">generated projects</.localized_link>. It provides commands for generating projects, caching binaries, running tests, sharing previews, and more.

Getting started {#getting-started}

If you haven't installed Tuist yet, follow the <.localized_link href="/guides/install-tuist">installation guide</.localized_link> to get started.

Once installed, you can run tuist in your terminal to see a list of available commands:

bash
tuist --help

Configuration {#configuration}

The CLI behavior can be configured through a tuist.toml file. See the <.localized_link href="/references/tuist-toml">tuist.toml reference</.localized_link> for all available options.

Troubleshooting {#troubleshooting}

If you run into issues, check the <.localized_link href="/cli/debugging">debugging guide</.localized_link> for tools to diagnose problems, including session logs and network recordings.