Skip to main content

​
Vercel

Manage Vercel projects, deployments, and environment variables.

​
Resources

​
Project

Create and manage Vercel projects. 
import { Project } from "alchemy/vercel";

const project = await Project("my-app", {
  name: "my-app",
  framework: "astro"
});

​
Props

​
name
string
default:"${app}-${stage}-${id}"
The desired name for the project (Maximum length: 100)
​
framework
string
The framework that is being used for this project. Supported frameworks include:
  • nextjs, react-router, astro, vite, remix, gatsby
  • svelte, sveltekit, vue, nuxtjs, angular
  • solidstart, hydrogen, docusaurus
  • And many more…
​
gitRepository
object
The Git Repository that will be connected to the project
​
environmentVariables
array
Collection of environment variables the project will use
​
buildCommand
string
The build command for this project. When null is used this value will be automatically detected
​
devCommand
string
The dev command for this project. When null is used this value will be automatically detected
​
installCommand
string
The install command for this project. When null is used this value will be automatically detected
​
outputDirectory
string
The output directory of the build. When null is used this value will be automatically detected
​
rootDirectory
string
The name of a directory or relative path to the source code of your project. When null is used it will default to the project root
​
publicSource
boolean
Specifies whether the source code and logs of the deployments for this project should be public or not
​
serverlessFunctionRegion
string
The region to deploy Serverless Functions in this project
​
enablePreviewFeedback
boolean
Opt-in to preview toolbar on the project level
​
enableProductionFeedback
boolean
Opt-in to production toolbar on the project level
​
resourceConfig
object
Resource configuration

​
Returns

​
id
string
The ID of the project
​
name
string
The name for the project
​
accountId
string
The account ID that the project belongs to
​
createdAt
number
The time at which the project was created
​
updatedAt
number
The time at which the project was last updated
​
latestDeployment
object
The latest deployment of the project

Build docs developers (and LLMs) love

Get started for freeTalk to us