Skip to content

README.md

Latest commit

 

History

History
62 lines (43 loc) · 1.24 KB

README.md

File metadata and controls

62 lines (43 loc) · 1.24 KB

Vercel Pause

A Textual User Interface (TUI) application to manage your Vercel projects. Easily view, pause, and unpause your Vercel projects directly from your terminal.

Features

  • Authentication: Secure login using Vercel Personal Access Tokens.
  • Dashboard: View all your Vercel projects along with their framework and status.
  • Control: Pause or unpause projects with a single keypress.

Prerequisites

  • Python 3.8+

Installation

You can run this application locally by cloning the repository.

  1. Clone the repository:

    git clone https://github.com/yourusername/vercel-pause.git
cd vercel-pause

  2. Create a virtual environment and activate it:

    python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

  3. Install the package:

    pip install -e .

Usage

After installation, you can launch the application by running:

vercel-pause

Or you can run the CLI script directly:

python -m vercel_pause.cli

Key Bindings

Login Screen:

  • Escape: Quit application

Dashboard Screen:

  • R: Refresh projects list
  • P: Pause selected project
  • U: Unpause selected project
  • Q: Quit application

License

MIT