source-from-vercel-deployment
v4.1.0
Published
A simple package made for downloading the source code from your Vercel Deployment.
Downloads
50
Maintainers
Readme
Download source from Vercel deployment
You can find the package on npm
Description
A simple package made for downloading the source code from your Vercel Deployment.
If you can't find your code anywhere but you have it deployed on Vercel, this package is for you.
You can easily download your code from any deployment that you've had on the project.
Installation
To install it (not required if you use npx), simply run
npm install -g source-from-vercel-deployment
How to run the command
After installing it globally, you can just type in CLI:
source-from-vercel-deployment
Or you can run it without installing using npx
npx source-from-vercel-deployment
You will then be prompted for the bellow mentioned values.
Usage
To run and download you're source code, you will be prompted for the following:
- AUTHORIZATION_TOKEN:
- You can generate one here
- You can save the generated token in your Environmental Variables with the key VERCEL_AUTH_TOKEN so you won't be asked for it from the script.
- Choose Team:
- The team that you're project is on (or your personal account)
- You can choose Personal project or select from the list of all teams that you are a part of.
- Choose Project Name:
- The project that contains the deployment that you whish to download the source for.
- You can choose from all the projects from the selected team (or personal account)
- Choose Deployment:
- The deployment inside of the project that you whish to download the source for.
- You can choose from all the deployments for the chosen project
- Choose OUTPUT_DIRECTORY:
- Where you want your deployment source to be placed
- Default value: './deployment_source'
Notes
Don't overuse this package. Use it only if you really need it. It's calling the endpoint for every file to download it might take a while and it will do many requests to the api.
If you get the error 429
with message TOO MANY REQUESTS
, it might mean that you've overused the package and made too many request. You have to wait a while until they reset.
( more info here )