> ## Documentation Index
> Fetch the complete documentation index at: https://docs.appz.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# appz init

> Learn how to initialize example Appz Projects locally using the `appz init` CLI command.

export const GlobalOptionsComponent = ({command}) => <div>
    <h2><a href="#global-options">Global Options</a></h2>
    <p>These general options can be applied when using the <code>{command}</code> command:</p>
    <ul>
    <li><code>--cwd</code></li>
    <li><code>--debug</code></li>
    <li><code>--global-config</code></li>
    <li><code>--help</code></li>
    <li><code>--local-config</code></li>
    <li><code>--no-color</code></li>
    <li><code>--scope</code></li>
    <li><code>--token</code></li>
    </ul>

    <p>For detailed information on these global options and their applications, refer to the <a href="/cli/global-options">options section</a>.</p>
    </div>;

The `appz init` command is used to initialize Appz Projects locally by leveraging several sources. It can pull examples from the Appz examples repository, clone directly from GitHub, GitLab, or Bitbucket repository URLs, or use public download URLs with template archive files such as zip, tar, or gz.

## Usage

```bash theme={null}
appz init
```

> Using the `appz init` command to initialize an Appz Project locally from the Appz examples repository.

## Extended Usage

### Initialize from a Project Name

```bash theme={null}
appz init [project-name]
```

> Using the `appz init` command to specifically initialize an Appz Project locally from the examples repository.

### Initialize from a Project Name and Rename Directory

```bash theme={null}
appz init [project-name] [new-project-name]
```

> Using the `appz init` command to initialize a specific Appz Project locally and rename the directory.

### Initialize from GitHub/GitLab/Bitbucket

```bash theme={null}
appz init [repo-url]
```

> Using the `appz init` command to initialize a project from any GitHub, GitLab, or Bitbucket repository URL.

### Initialize from a Public Download URL

```bash theme={null}
appz init [download-url]
```

> Using the `appz init` command to initialize a project from a url of multiple archive formats. Currently supports `.tar (gz, xz, zstd)` and `.zip`.

## Unique Options

### Force

The `--force` option, abbreviated as `-f`, is used to forcibly overwrite an existing local directory.

```bash theme={null}
appz init --force
```

> Using the `appz init` command with the `--force` option to forcefully replace any existing directory.

```bash theme={null}
appz init gatsby my-project-directory --force
```

> Using the `appz init` command with the `--force` option, specifying a project example and a new directory name.

<GlobalOptionsComponent command={'appz init'} />