vercel init

Learn how to initialize example Vercel Projects locally using the vercel init CLI command.
Table of Contents

The vercel init command is used to initialize Vercel Projects locally from the examples found in the Vercel examples repository.

terminal
vercel init

Using the vercel init command to initialize a Vercel Project locally.

terminal
vercel init [project-name]

Using the vercel init command to initialize a specific Vercel Project locally.

terminal
vercel init [project-name] [new-project-name]

Using the vercel init command to initialize a specific Vercel Project locally and rename the directory.

These are options that only apply to the vercel env command.

The --force option, shorthand -f, is used to forcibly replace an existing local directory.

terminal
vercel init --force

Using the vercel init command with the --force option.

terminal
vercel init gatsby my-project-directory --force

Using the vercel init command with the --force option.

The following global options can be passed when using the vercel init command:

For more information on global options and their usage, refer to the options section.

Last updated on October 4, 2024