https://github.com/aarondill/vercel-project-manager

A VSCode extension for managing Vercel projects and environments.
https://github.com/aarondill/vercel-project-manager

vercel vercel-manager vscode vscode-extension

Last synced: 2 months ago
JSON representation

A VSCode extension for managing Vercel projects and environments.

• Host: GitHub
• URL: https://github.com/aarondill/vercel-project-manager
• Owner: aarondill
• License: mit
• Created: 2022-12-12T04:01:50.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-30T06:11:51.000Z (5 months ago)
• Last Synced: 2024-07-30T09:28:07.799Z (5 months ago)
• Topics: vercel, vercel-manager, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=AaronDill.vercel-project-manager-vscode
• Size: 561 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: License.txt

Awesome Lists containing this project

README

        
# Vercel Project Manager

Manage Vercel projects from the comfort of VSCode

Available on the [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=AaronDill.vercel-project-manager-vscode)!

![Image of side panel](side-panel-screenshot.png)

### Important note:

The CLI commands require the [Vercel CLI](https://vercel.com/docs/cli) to be installed. You can still use this extension without it, however generally, this CLI creates the `.vercel/project.json` required for this extension to detect the current project.

Without the Vercel CLI installed **globally** (install with `npm i -g vercel`) the following commands will not work:

- Run a development server through Vercel

- Link current workspace to a Vercel project

- Deploy working directory to Vercel

## Features

- Manage deployments in the activity panel

- Add, edit, and remove environment variables without ever leaving VSCode!

## Setup

This extension will automatically detect any project with a `.vercel/project.json` file in it and use the project id defined in that file. If you are unsure of where that file comes from, check out the [Vercel CLI](https://vercel.com/docs/cli).

If you already have the Vercel CLI installed, run `vercel link` in your terminal or use the button on the side panel to connect to a Vercel project.

Run the `Log in` command to log into your vercel account.

Note: When using the CLI, you may need to log in a second time.

## Extension Settings

This extension contributes the following settings:

- `vercel.RefreshRate`: Number of minutes to wait between refreshes of Deployments and Environment. (Default 5 minutes)

- `vercel.DeploymentCount`: Number of deployments to display from Vercel. (Default 20)

- `vercel.TeamDashboardURL`: (For use with teams) The URL to append the project name to.

## Contributing

- Run `npm run compile` to compile your changes into the `dist` directory

- Run `npm run watch` to compile your changes and recompile when a file changes.

- Run `npm run lint` to lint the src directory for typos and errors and fix them if possible.

- Run `npm run package` to compile the extension in a production environment

- Run `npm run ext:package` to package the extension into a `*.vsix` file to be installed with `code --install-extension ""` (vsce is required to be installed for this!)