Tuist

https://docs.tuist.dev
Admin
Tuist extends Apple's toolchain to help teams scale by generating consistent Xcode projects,...
Tokens:236,761
Snippets:3,269
Trust Score:7.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Set up and run Tuist server locally

Source: https://docs.tuist.dev/en/contributors/code/server

Commands to initialize the environment, start required databases, install dependencies, and launch the development server.

```bash
cd server 
mise install 
 
# Dependencies 
brew services start postgresql@16 
mise run clickhouse:start 
 
# Install dependencies + set up the database 
mise run install 
 
# Run the server 
mise run dev
```

--------------------------------

### Enable machine metrics daemon

Source: https://docs.tuist.dev/en/guides/features/build-insights/xcode

Run the setup command to start a background daemon that samples system performance metrics.

```bash
tuist setup insights
```

--------------------------------

### Install all skills

Source: https://docs.tuist.dev/en/guides/features/agentic-coding/skills

Installs all available skills using an interactive prompt to select agents.

```bash
npx skills add tuist/agent-skills
```

--------------------------------

### GitHub Actions Workflow for Tuist Cache Setup

Source: https://docs.tuist.dev/en/guides/features/cache/xcode-cache

Example GitHub Actions workflow demonstrating how to set up Tuist caching using OIDC authentication. Ensure you have the necessary permissions and steps for authentication and cache setup.

```yaml
name: Build 

permissions:
  id-token: write
  contents: read

jobs:
  build:
    runs-on: macos-latest
    steps:
      - uses: actions/checkout@v4
      - uses: jdx/mise-action@v2
      - run: tuist auth login
      - run: tuist setup cache
      - # Your build steps
```

--------------------------------

### Install globally

Source: https://docs.tuist.dev/en/guides/features/agentic-coding/skills

Installs skills in the home directory for availability across all projects.

```bash
npx skills add tuist/agent-skills -g
```

--------------------------------

### Install dependencies by path

Source: https://docs.tuist.dev/pl/cli/install

Specifies the directory or subdirectory of the project to install dependencies for.

```bash
tuist install --path [path] 
tuist install -p [path] 
```

--------------------------------

### Install with Path Argument

Source: https://docs.tuist.dev/ar/cli/install

Use the --path or -p flag to specify the directory for installation. This is useful when your project is not in the current working directory.

```bash
tuist install --path [path]
tuist install -p [path]
```

--------------------------------

### Resolve and Install Dependencies

Source: https://docs.tuist.dev/en/guides/features/projects/dependencies

Execute the install command to fetch and resolve dependencies into the Tuist/Dependencies directory.

```bash
tuist install 
# Resolving and fetching dependencies. 
# Installing Swift Package Manager dependencies.
```

--------------------------------

### GitHub Actions Workflow for Tuist Cache

Source: https://docs.tuist.dev/zh_Hans/guides/features/cache/xcode-cache

Example GitHub Actions workflow demonstrating how to set up the Tuist cache service and ensure the `TUIST_TOKEN` environment variable is available for CI builds. The `tuist setup cache` command must be run within the build steps.

```yaml
name: Build 

env: 
 TUIST_TOKEN: ${{ secrets.TUIST_TOKEN }} 

jobs:
 build:
 steps:
 - # Your set up steps...
 - name: Set up Tuist Cache 
 run: tuist setup cache 
 - # Your build steps 

```

--------------------------------

### Run tuist setup cache

Source: https://docs.tuist.dev/en/cli/setup/cache

Executes the setup cache command to configure the project cache, with an optional path argument.

```bash
tuist setup cache --path [path] 
tuist setup cache -p [path] 
```

--------------------------------

### Example tuist.toml Configuration

Source: https://docs.tuist.dev/en/references/tuist-toml

This is an example of a basic tuist.toml file. It specifies the project handle and the URL for the Tuist server.

```toml
project = "tuist/tuist" 
url = "https://tuist.dev" 
```

--------------------------------

### Install a specific skill

Source: https://docs.tuist.dev/en/guides/features/agentic-coding/skills

Targets a single skill for installation.

```bash
npx skills add tuist/agent-skills --skill migrate
```

--------------------------------

### Install Fish completion

Source: https://docs.tuist.dev/pt/cli/shell-completions

Create the completions directory and generate the tuist.fish script.

```bash
mkdir -p ~/.config/fish/completions
tuist --generate-completion-script > ~/.config/fish/completions/tuist.fish
```

--------------------------------

### Install Fish shell completions

Source: https://docs.tuist.dev/en/cli/shell-completions

Create the completions directory and generate the tuist.fish script.

```bash
mkdir -p ~/.config/fish/completions 
tuist --generate-completion-script > ~/.config/fish/completions/tuist.fish
```

--------------------------------

### Setup Package Registry Manually

Source: https://docs.tuist.dev/en/guides/features/registry

Manually set up the package registry by running the `tuist registry setup` command in your project's directory. This generates a configuration file that enables the registry for your project.

```bash
tuist registry setup

```

--------------------------------

### Install Tuist Dependencies

Source: https://docs.tuist.dev/en/contributors/code/cli

Run this command after cloning the repository to install necessary dependencies for local development.

```bash
tuist install
```

--------------------------------

### Setup VS Code globally

Source: https://docs.tuist.dev/ar/cli/mcp/setup/vscode

Configures the MCP server for VS Code globally.

```bash
tuist mcp setup vscode --global 
```

--------------------------------

### tuist setup cache

Source: https://docs.tuist.dev/es/cli/setup

Sets up the Tuist Xcode cache.

```APIDOC
## tuist setup cache

### Description
Sets up the Tuist Xcode cache.

### Method
CLI Command

### Endpoint
N/A

### Parameters
N/A

### Request Example
```bash
tuist setup cache
```

### Response
N/A
```

--------------------------------

### Start Tuist Cache Service

Source: https://docs.tuist.dev/en/guides/cache/self-host

Starts the Tuist cache service in detached mode using Docker Compose. Ensure Docker is installed and running.

```bash
docker compose up -d
```

--------------------------------

### Set up documentation locally

Source: https://docs.tuist.dev/en/contributors/code/docs

Commands to navigate to the docs directory and start the development server using mise.

```bash
cd docs 
mise install 
mise run dev
```

--------------------------------

### Manual installation variables

Source: https://docs.tuist.dev/en/guides/features/agentic-coding/skills

Defines the environment variables required for manual skill file downloads.

```bash
SKILL_NAME=tuist-migrate # or tuist-generated-projects 
SKILL_URL=https://tuist.dev/skills/migrate/SKILL.md # or .../generated-projects/SKILL.md
```

--------------------------------

### Initialize project directory structure

Source: https://docs.tuist.dev/pt/guides/features/projects/adoption/new-project

Creates the base directory for a new project and navigates into it.

```bash
mkdir MyFramework 
cd MyFramework
```

--------------------------------

### Setup Cursor with Path Argument

Source: https://docs.tuist.dev/en/cli/mcp/setup/cursor

Configures the Cursor IDE for a specific directory path.

```bash
tuist mcp setup cursor --path [path] 
tuist mcp setup cursor -p [path] 
```

--------------------------------

### Create a project with a full handle

Source: https://docs.tuist.dev/es/cli/project/create

Initializes a new project using the required account-handle/project-handle format.

```bash
tuist project create [full-handle] 
```

--------------------------------

### GitHub Actions CI Configuration

Source: https://docs.tuist.dev/pt/guides/integrations/continuous-integration

Examples for configuring Tuist on GitHub Actions using OIDC or project tokens, with installation via Mise or Homebrew.

```yaml
name: Build Application 
on: 
 pull_request: 
 branches: 
 - main 
 push: 
 branches: 
 - main 
 
permissions: 
 id-token: write 
 contents: read 
 
jobs: 
 build: 
 runs-on: macos-latest 
 steps: 
 - uses: actions/checkout@v4 
 - uses: jdx/mise-action@v2 
 - run: tuist auth login 
 - run: tuist setup cache
```

```yaml
name: Build Application 
on: 
 pull_request: 
 branches: 
 - main 
 push: 
 branches: 
 - main 
 
permissions: 
 id-token: write 
 contents: read 
 
jobs: 
 build: 
 runs-on: macos-latest 
 steps: 
 - uses: actions/checkout@v4 
 - run: brew install --formula tuist@x.y.z 
 - run: tuist auth login 
 - run: tuist setup cache
```

```yaml
name: Build Application 
on: 
 pull_request: 
 branches: 
 - main 
 push: 
 branches: 
 - main 
 
env: 
 TUIST_TOKEN: ${{ secrets.TUIST_TOKEN }} 
 
jobs: 
 build: 
 runs-on: macos-latest 
 steps: 
 - uses: actions/checkout@v4 
 - uses: jdx/mise-action@v2 
 - run: tuist setup cache
```

```yaml
name: Build Application 
on: 
 pull_request: 
 branches: 
 - main 
 push: 
 branches: 
 - main 
 
env: 
 TUIST_TOKEN: ${{ secrets.TUIST_TOKEN }} 
 
jobs: 
 build: 
 runs-on: macos-latest 
 steps: 
 - uses: actions/checkout@v4 
 - run: brew install --formula tuist@x.y.z 
 - run: tuist setup cache
```

--------------------------------

### Set up Tuist Handbook Locally

Source: https://docs.tuist.dev/en/contributors/code/handbook

Follow these steps to set up the Tuist handbook documentation locally. Ensure you have `mise` installed.

```bash
cd handbook 
 mise install 
 mise run dev
```

--------------------------------

### Install Tuist with Homebrew

Source: https://docs.tuist.dev/en/guides/install-tuist

Install Tuist using Homebrew formulas on macOS. You can install a specific version or the latest available.

```bash
brew tap tuist/tuist
```

```bash
brew install --formula tuist
```

```bash
brew install --formula tuist@x.y.z
```

--------------------------------

### List builds by project

Source: https://docs.tuist.dev/ar/cli/build/list

Specify the project using the full handle format account-handle/project-handle.

```bash
tuist build list --project [project] 
tuist build list -P [project] 
```

--------------------------------

### Create Project Directories

Source: https://docs.tuist.dev/en/guides/features/projects/adoption/new-project

Before manually creating project files, set up the necessary directory structure for your framework project. Navigate into the newly created directory.

```bash
mkdir MyFramework 
cd MyFramework 

```

--------------------------------

### Install Tuist Dependencies

Source: https://docs.tuist.dev/pt/contributors/get-started

Install system and external dependencies required for Tuist development using Mise and the `tuist install` command.

```bash
mise install
```

```bash
tuist install
```

--------------------------------

### Install Tuist CLI with Mise

Source: https://docs.tuist.dev/ar

Use the 'mise' package manager to install the Tuist CLI. Ensure 'mise' is installed first.

```bash
mise install tuist
```

--------------------------------

### Set up Tuist Registry

Source: https://docs.tuist.dev/ar/cli/registry/setup

Use these commands to initialize the registry for a project at a specified path.

```bash
tuist registry setup --path [path] 
tuist registry setup -p [path] 
```

--------------------------------

### Tuist Directory Structure

Source: https://docs.tuist.dev/yue_Hant/guides/features/projects/adoption/migrate/xcodegen-project

Example directory structure for a Tuist project, including manifest files.

```bash
/ 
 Tuist.swift 
 Project.swift 
 Workspace.swift
```

--------------------------------

### POST /registry/setup

Source: https://docs.tuist.dev/pl/cli/registry/setup

Sets up the Tuist Registry for a specified project path.

```APIDOC
## POST /registry/setup

### Description
Initializes the Tuist Registry for the project located at the provided path.

### Method
POST

### Endpoint
tuist registry setup

### Parameters
#### Query Parameters
- **path** (string) - Optional - The path to the directory that contains the project to set up the registry for. Can also be set via the TUIST_REGISTRY_SETUP_PATH environment variable.

### Request Example
tuist registry setup --path /path/to/project
```

--------------------------------

### Install Tuist with Mise

Source: https://docs.tuist.dev/yue_Hant/guides/quick-start/install-tuist

Use these commands to install Tuist using Mise. Mise allows for managing different versions of tools. Ensure you have Mise installed and configured.

```bash
mise install tuist # Install the current version specified in .tool-versions/.mise.toml
```

```bash
mise install tuist@x.y.z # Install a specific version number
```

```bash
mise install tuist@3 # Install a fuzzy version number
```

--------------------------------

### Initialize Project with Path

Source: https://docs.tuist.dev/en/cli/init

Use the `path` argument to specify the directory where the project should be initialized. The short flag `-p` is also available.

```bash
tuist init --path [path]
```

```bash
tuist init -p [path]
```

--------------------------------

### Install and pin Tuist with Mise

Source: https://docs.tuist.dev/en/guides/install-tuist

Use `mise use` to install and pin a specific version of Tuist in the current project or globally. Ensure Mise is installed first.

```bash
mise use tuist@x.y.z # Install and pin tuist-x.y.z in the current project
```

```bash
mise use tuist@latest # Install and pin the latest tuist in the current project
```

```bash
mise use -g tuist@x.y.z # Install and pin tuist-x.y.z as the global default
```

```bash
mise use -g tuist@system # Use the system's tuist as the global default
```

--------------------------------

### Install for a specific agent

Source: https://docs.tuist.dev/en/guides/features/agentic-coding/skills

Restricts the installation to a specific coding agent.

```bash
npx skills add tuist/agent-skills -a claude-code
```

--------------------------------

### Start Tuist Services

Source: https://docs.tuist.dev/pt/guides/server/self-host/install

Starts the local Docker Compose services.

```bash
docker compose up -d 
# or with podman: 
podman compose up -d
```

--------------------------------

### Clone Repository and Navigate

Source: https://docs.tuist.dev/yue_Hant/guides/features/projects/adoption/swift-package

Clone the Swift Package repository and navigate into its directory to begin.

```bash
git clone https://github.com/TootSDK/TootSDK 
cd TootSDK
```

--------------------------------

### Non-interactive installation

Source: https://docs.tuist.dev/en/guides/features/agentic-coding/skills

Performs installation without user prompts, suitable for CI environments.

```bash
npx skills add tuist/agent-skills --all -y
```

--------------------------------

### Configure Environment Variables for Local Development

Source: https://docs.tuist.dev/en/guides/server/self-host/install

Copy the example environment file and edit it to include your TUIST_LICENSE and GitHub authentication credentials.

```bash
cp .env.example .env 
# Edit .env and add your TUIST_LICENSE and authentication credentials 

```

--------------------------------

### Initialize Tuist Project

Source: https://docs.tuist.dev/en/guides/features/cache/xcode-cache

Run this command to create a new Tuist project if you don't have one.

```bash
tuist init
```

--------------------------------

### tuist install

Source: https://docs.tuist.dev/ar/cli/install

Installs any remote content (e.g. dependencies) necessary to interact with the project.

```APIDOC
## tuist install

### Description
Installs any remote content (e.g. dependencies) necessary to interact with the project.

### Method
Not applicable (CLI command)

### Endpoint
Not applicable (CLI command)

### Arguments
#### path `Optional`
**Environment variable**: `TUIST_INSTALL_PATH`
The path to the directory or a subdirectory of the project.

Example:
```bash
tuist install --path [path]
tuist install -p [path]
```

#### update `Optional`
**Environment variable**: `TUIST_INSTALL_UPDATE`
Instead of simple install, update external content when available.

Example:
```bash
tuist install --update
tuist install -u
```

#### no-update `Optional`
**Environment variable**: `TUIST_INSTALL_UPDATE`
Instead of simple install, update external content when available.

Example:
```bash
tuist install --no-update
```

#### passthrough-arguments `Optional`
**Environment variable**: `TUIST_INSTALL_PASSTHROUGH_ARGUMENTS`
Arguments to pass to the underlying 'swift package' invocation.

Example:
```bash
tuist install [passthrough-arguments]
```

### Request Example
Not applicable (CLI command)

### Response
Not applicable (CLI command)
```

--------------------------------

### Setup Tuist Registry

Source: https://docs.tuist.dev/pt/guides/features/registry

Run this command in your project's directory to generate a configuration file that enables the Tuist Registry for your project. Commit this file to share the configuration with your team.

```bash
tuist registry setup
```

--------------------------------

### Show build information by path

Source: https://docs.tuist.dev/ar/cli/build/show

Provide a path to a directory or subdirectory of the project to retrieve build information. Use the `--path` or `-p` flag.

```bash
tuist build show --path [path]
```

```bash
tuist build show -p [path]
```

--------------------------------

### Conventional Commit Example - CI

Source: https://docs.tuist.dev/en/contributors/releases

Example of a commit message for CI/CD changes, which do not trigger a release.

```text
ci: add workflow for releases
```

--------------------------------

### Conventional Commit Example - Chore

Source: https://docs.tuist.dev/en/contributors/releases

Example of a commit message for maintenance tasks, which do not trigger a release.

```text
chore: update dependencies
```

--------------------------------

### Conventional Commit Example - Refactor

Source: https://docs.tuist.dev/en/contributors/releases

Example of a commit message for code refactoring, which does not trigger a release.

```text
refactor(server): simplify auth logic
```

--------------------------------

### Conventional Commit Example - Docs

Source: https://docs.tuist.dev/en/contributors/releases

Example of a commit message for documentation changes, which do not trigger a release.

```text
docs: update installation guide
```

--------------------------------

### List test cases by project

Source: https://docs.tuist.dev/ar/cli/test/case/list

Specify the project using the full handle format account-handle/project-handle.

```bash
tuist test case list --project [project] 
tuist test case list -P [project]
```

--------------------------------

### Install Tuist macOS app

Source: https://docs.tuist.dev/en/guides/features/previews

Install the Tuist macOS menu bar app via Homebrew.

```bash
brew install --cask tuist/tuist/tuist
```

--------------------------------

### Setup VS Code with path argument

Source: https://docs.tuist.dev/ar/cli/mcp/setup/vscode

Configures the MCP server for a specific directory path.

```bash
tuist mcp setup vscode --path [path] 
tuist mcp setup vscode -p [path] 
```

--------------------------------

### Conventional Commit Example - Test

Source: https://docs.tuist.dev/en/contributors/releases

Example of a commit message for test additions or changes, which do not trigger a release.

```text
test: add unit tests for cache
```

--------------------------------

### Create a project with a specific build system

Source: https://docs.tuist.dev/es/cli/project/create

Defines the build system to be used for the new project.

```bash
tuist project create --build-system [build-system] 
```

--------------------------------

### Conventional Commit Example - Style

Source: https://docs.tuist.dev/en/contributors/releases

Example of a commit message for code style changes, which do not trigger a release.

```text
style: format code with swiftformat
```

--------------------------------

### Install Tuist with Homebrew

Source: https://docs.tuist.dev/pt/guides/quick-start/install-tuist

Commands to install Tuist via the Homebrew package manager using the official tap.

```bash
brew tap tuist/tuist 
brew install --formula tuist 
brew install --formula tuist@x.y.z
```

--------------------------------

### Manual installation for agents

Source: https://docs.tuist.dev/en/guides/features/agentic-coding/skills

Commands to manually download and place SKILL.md files for various supported agents.

```bash
mkdir -p .claude/skills/$SKILL_NAME 
curl -o .claude/skills/$SKILL_NAME/SKILL.md $SKILL_URL
```

```bash
mkdir -p .codex/skills/$SKILL_NAME 
curl -o .codex/skills/$SKILL_NAME/SKILL.md $SKILL_URL
```

```bash
mkdir -p .agents/skills/$SKILL_NAME 
curl -o .agents/skills/$SKILL_NAME/SKILL.md $SKILL_URL
```

```bash
mkdir -p .opencode/skills/$SKILL_NAME 
curl -o .opencode/skills/$SKILL_NAME/SKILL.md $SKILL_URL
```

--------------------------------

### Install Tuist with Mise

Source: https://docs.tuist.dev/pt/guides/quick-start/install-tuist

Commands to install specific or current versions of Tuist using the Mise tool manager.

```bash
mise install tuist # Install the current version specified in .tool-versions/.mise.toml 
mise install tuist@x.y.z # Install a specific version number 
mise install tuist@3 # Install a fuzzy version number
```

--------------------------------

### Show bundle information for a project

Source: https://docs.tuist.dev/zh_Hans/cli/bundle/show

Specifies the project handle in account-handle/project-handle format.

```bash
tuist bundle show --project [project] 
tuist bundle show -P [project] 
```

--------------------------------

### Connect local project to server

Source: https://docs.tuist.dev/pt/guides/quick-start/gather-insights

Configure the project handle in your Tuist.swift file to link your local project to the server.

```swift
import ProjectDescription 
 
let tuist = Tuist(fullHandle: "my-handle/MyApp")
```

--------------------------------

### Xcode Cloud: Install Tuist with Homebrew

Source: https://docs.tuist.dev/en/guides/integrations/continuous-integration

Install Tuist using Homebrew in an Xcode Cloud post-clone script.

```bash
#!/bin/sh 
brew install --formula tuist@x.y.z 

tuist generate 

```

--------------------------------

### GitHub Actions CI workflow example

Source: https://docs.tuist.dev/pt/guides/features/cache/xcode-cache

Example workflow configuration for enabling Tuist cache in GitHub Actions.

```yaml
name: Build 
 
env: 
 TUIST_TOKEN: ${{ secrets.TUIST_TOKEN }} 
 
jobs: 
 build: 
 steps: 
 - # Your set up steps... 
 - name: Set up Tuist Cache 
 run: tuist setup cache 
 - # Your build steps
```

--------------------------------

### Setup Tuist Cache

Source: https://docs.tuist.dev/en/guides/features/cache/xcode-cache

Run this command to set up the local cache service. This command needs to be run once in both your local and CI environments.

```bash
tuist setup cache
```

--------------------------------

### Conventional Commit Example - Perf

Source: https://docs.tuist.dev/en/contributors/releases

Example of a commit message for performance improvements, indicating a patch version bump.

```text
perf(cli): optimize dependency resolution
```

--------------------------------

### Create an organization with a path

Source: https://docs.tuist.dev/pt/cli/organization/create

Use these commands to specify the directory or subdirectory path for the organization creation.

```bash
tuist organization create --path [path] 
tuist organization create -p [path] 
```

--------------------------------

### Conventional Commit Example - Fix

Source: https://docs.tuist.dev/en/contributors/releases

Example of a commit message for a bug fix, indicating a patch version bump.

```text
fix(app): resolve crash when opening projects
```

--------------------------------

### Initialize and Generate SPM Projects

Source: https://docs.tuist.dev/pt/guides/features/projects/directory-structure

Commands to set up and generate an Xcode project from an existing Swift Package.

```bash
tuist install
tuist generate
```

--------------------------------

### Define a Project with Project.swift

Source: https://docs.tuist.dev/en/guides/features/projects/adoption/migrate/swift-package

Create a Project.swift file to define project targets using the ProjectDescription framework.

```swift
import ProjectDescription 
 
let project = Project( 
 name: "App", 
 targets: [ 
 .target( 
 name: "App", 
 destinations: .iOS, 
 product: .app, 
 bundleId: "dev.tuist.App", 
 sources: ["Sources/**/*.swift"]* 
 ), 
 ] 
)
```

--------------------------------

### Conventional Commit Example - Feat

Source: https://docs.tuist.dev/en/contributors/releases

Example of a commit message for a new feature, indicating a minor version bump.

```text
feat(cli): add support for Swift 6
```

--------------------------------

### Create a new project on the server

Source: https://docs.tuist.dev/pt/guides/quick-start/gather-insights

Use this command to register a new project handle on the Tuist server.

```bash
tuist project create my-handle/MyApp
```

--------------------------------

### Open project in browser

Source: https://docs.tuist.dev/ar/cli/project/show

Opens the project details in the default web browser.

```bash
tuist project show --web 
```

--------------------------------

### GitHub Actions: Homebrew Installation with OIDC

Source: https://docs.tuist.dev/en/guides/integrations/continuous-integration

Install Tuist using Homebrew on GitHub Actions with OIDC authentication. Requires `permissions: id-token: write`.

```yaml
name: Build Application 
on: 
 pull_request: 
 branches: 
 - main 
 push: 
 branches: 
 - main 
 
permissions: 
 id-token: write 
 contents: read 
 
jobs: 
 build: 
 runs-on: macos-latest 
 steps: 
 - uses: actions/checkout@v4 
 - run: brew install --formula tuist@x.y.z 
 - run: tuist auth login 
 - run: tuist setup cache 

```

--------------------------------

### List builds by path

Source: https://docs.tuist.dev/ar/cli/build/list

Specify the directory or subdirectory path of the project.

```bash
tuist build list --path [path] 
tuist build list -p [path] 
```

--------------------------------

### Start Tuist Server Services with Docker Compose

Source: https://docs.tuist.dev/en/guides/server/self-host/install

Start all required services for Tuist server locally using Docker Compose in detached mode.

```bash
docker compose up -d 
# or with podman: 
podman compose up -d 

```

--------------------------------

### Setup Tuist Cache Service

Source: https://docs.tuist.dev/zh_Hans/guides/features/cache/xcode-cache

Execute this command to set up the local cache service. It creates a LaunchAgent that the Swift build system uses to share compiled artifacts. This command needs to be run once locally and on CI environments.

```bash
tuist setup cache 

```

--------------------------------

### Commit Message Example - Do

Source: https://docs.tuist.dev/en/contributors/releases

Example of a well-formed commit message following best practices, including present tense, conciseness, scope, and issue referencing.

```text
fix(cli): resolve build cache issue (#1234)
```

--------------------------------

### Specify build system for project creation

Source: https://docs.tuist.dev/ar/cli/project/create

Use the --build-system flag to define the build system for the new project.

```bash
tuist project create --build-system [build-system]
```

--------------------------------

### Breaking Change Commit Example - Body

Source: https://docs.tuist.dev/en/contributors/releases

Another example of a commit message for a breaking change, emphasizing the use of 'BREAKING CHANGE:' in the commit body.

```plaintext
feat(cli): change cache directory structure 

BREAKING CHANGE: Cache files are now stored in a new directory structure. 
Users need to clear their cache after updating. 

```

--------------------------------

### Xcode Cloud: Install Tuist with Mise

Source: https://docs.tuist.dev/en/guides/integrations/continuous-integration

Install Tuist using Mise in an Xcode Cloud post-clone script. Assumes `.mise.toml` is present for version pinning.

```bash
#!/bin/sh 

# Mise installation taken from https://mise.jdx.dev/continuous-integration.html#xcode-cloud 
curl https://mise.run | sh # Install Mise 
export PATH="$HOME/.local/bin:$PATH" 

mise install # Installs the version from .mise.toml 

# Runs the version of Tuist indicated in the .mise.toml file 
mise exec -- tuist install --path ../ # `--path` needed as this is run from within the `ci_scripts` directory 
mise exec -- tuist generate -p ../ --no-open # `-p` needed as this is run from within the `ci_scripts` directory 

```

--------------------------------

### Build plugin and show binary output path

Source: https://docs.tuist.dev/ar/cli/plugin/build

Print the binary output path of the built plugin. Use '--no-show-bin-path' to disable this.

```bash
tuist plugin build --show-bin-path
```

--------------------------------

### Codemagic Workflow with Mise and Project Token

Source: https://docs.tuist.dev/pt/guides/integrations/continuous-integration

Set up your Codemagic workflow to install Mise and Tuist using the 'mise install' command. Ensure the TUIST_TOKEN secret is configured in Codemagic for authentication.

```yaml
workflows:
 build:
 name: Build
 max_build_duration: 30
 environment:
 xcode: 15.0.1
 vars:
 TUIST_TOKEN: ${{ secrets.TUIST_TOKEN }}
 scripts:
 - name: Install Mise
 script: |
 curl https://mise.jdx.dev/install.sh | sh
 mise install # Installs the version from .mise.toml
 - name: Build
 script: mise exec -- tuist setup cache

```

--------------------------------

### Open the project

Source: https://docs.tuist.dev/yue_Hant/contributors/get-started

Commands to open the workspace. Note that xed . opens the package instead of the generated project.

```bash
open Tuist.xcworkspace
```

```bash
xed .
```

--------------------------------

### Breaking Change Commit Example

Source: https://docs.tuist.dev/en/contributors/releases

Example of a commit message indicating a breaking change, which triggers a major version bump. The 'BREAKING CHANGE:' keyword in the body is essential for proper detection.

```plaintext
feat(cli): change default cache location 

BREAKING CHANGE: The cache is now stored in ~/.tuist/cache instead of .tuist-cache. 
Users will need to clear their old cache directory. 

```

--------------------------------

### Update skills

Source: https://docs.tuist.dev/en/guides/features/agentic-coding/skills

Updates existing installed skills.

```bash
npx skills update
```

--------------------------------

### Create a project with a custom path

Source: https://docs.tuist.dev/es/cli/project/create

Specifies the directory where the project should be created using the path argument.

```bash
tuist project create --path [path] 
tuist project create -p [path] 
```

--------------------------------

### Build plugin with specified products

Source: https://docs.tuist.dev/ar/cli/plugin/build

Build only the products specified in the argument.

```bash
tuist plugin build --products [products]
```

--------------------------------

### POST /api/cache/module/start

Source: https://docs.tuist.dev/en/guides/cache/architecture

Starts a multipart upload for a module.

```APIDOC
## POST /api/cache/module/start

### Description
Starts a multipart upload for a module.

### Method
POST

### Endpoint
/api/cache/module/start
```

--------------------------------

### GET /api/cache/module/:id

Source: https://docs.tuist.dev/en/guides/cache/architecture

Downloads a module artifact.

```APIDOC
## GET /api/cache/module/:id

### Description
Downloads a module artifact.

### Method
GET

### Endpoint
/api/cache/module/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The module artifact ID
```
Tokens:
Raw