Linking Projects with Vercel CLI
When running vercel in a directory for the first time, Vercel CLI needs to know which team and Vercel Project you
want to deploy your directory to. You can choose to either link an existing Vercel Project or to create a new one.
After you pick a team, the CLI searches that team for projects connected to your local Git repository. If it finds none, it searches for a project that matches your local directory name (after slugifying). The Which project? prompt lists the matches first, followed by options to search all projects or create a new project:
vercel
Directory ~/web/my-lovely-project
? Which team? My Awesome Team (awesome-team)
? Which project? my-lovely-project (folder name)
✓ Linked awesome-team/my-lovely-projectLinking an auto-detected Vercel Project when the local directory name matches an existing project in the selected team.
If no project matches (or you don't want the suggested project), select Search all projects and choose an existing project from the list:
vercel
Directory ~/web/release-notes
? Which team? My Awesome Team (awesome-team)
? Which project? Search all projects
? Which project? marketing-site
✓ Linked awesome-team/marketing-siteLinking an existing Vercel Project by name when no project matches the local directory name.
Once set up, a new .vercel directory is added to your directory. The .vercel/project.json file contains the orgId and projectId of your Vercel Project. If you link a project that the CLI found through your Git repository, the CLI saves the link in .vercel/repo.json at the root of the repository instead. To unlink your directory, remove the .vercel directory.
You can use the --yes option to skip the project questions. The --yes option does not choose a team. If you belong to more than one team, also pass the --scope option.
When you create a new Vercel Project, Vercel CLI links the Vercel Project and automatically detects the framework you are using and offers default Project Settings accordingly.
vercel
Directory ~/web/my-new-project
? Which team? My Awesome Team (awesome-team)
? Which project? Create a new project
? Name? my-new-project
Detected Next.js (Build Command: next build, Output Directory: Next.js default)
? Customize settings? (y/N)Creating a new Vercel Project with the vercel
command.
The status line shows Build Command and Output Directory inline. If you answer y to Customize settings?, the CLI presents a checklist for overriding the detected settings (Build Command, Development Command, Output Directory). You can continue with the defaults or override them now; you can also edit settings later in your Vercel Project dashboard.
Was this helpful?