CLI Installation

Overview

The VibeHub CLI (vibe) lets you push commits, sync code, and manage projects directly from your terminal. It’s the primary way to send commits from your local development environment to VibeHub.

Requirements

Node.js version 18.0.0 or higher
npm or yarn package manager
A VibeHub account

Installation

Using npm (Recommended)

npm install -g @vibehub/cli

Using yarn

yarn global add @vibehub/cli

Verify Installation

After installation, verify it worked:

vibe --version

You should see the version number printed.

First-Time Setup

After installing, you need to authenticate:

vibe login

This opens your browser to sign in with your VibeHub account. Once authenticated, you’re ready to use the CLI. See Authentication for more details.

Basic Commands

Here are the most common commands to get started:

Command	Description
`vibe login`	Authenticate with VibeHub
`vibe init`	Initialize a new VibeHub project
`vibe set <url>`	Connect to an existing project
`vibe push`	Push commits to VibeHub
`vibe pull`	Pull commits from VibeHub
`vibe status`	Check sync status

Quick Start Example

# 1. Login to VibeHub
vibe login

# 2. Navigate to your project
cd my-project

# 3. Connect to a VibeHub project
vibe set https://vibehub.co.in/username/my-project

# 4. Push your code
vibe push

Getting Help

Command Help

Get help for any command:

vibe --help
vibe push --help
vibe login --help

List All Commands

vibe --help

Updating the CLI

To update to the latest version:

npm

npm update -g @vibehub/cli

yarn

yarn global upgrade @vibehub/cli

Uninstalling

To remove the CLI:

npm

npm uninstall -g @vibehub/cli

yarn

yarn global remove @vibehub/cli

Troubleshooting

Command Not Found

If vibe is not recognized:

Check that npm’s global bin is in your PATH
Try running npm bin -g to find the path
Add that path to your shell configuration

Permission Errors

If you get permission errors during installation:

# Option 1: Use sudo (Linux/Mac)
sudo npm install -g @vibehub/cli

# Option 2: Fix npm permissions (recommended)
# See: https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally

Node Version Too Old

If you see Node version errors:

Check your Node version: node --version
Update Node to version 18 or higher
Consider using nvm to manage Node versions

Next Steps

Authentication

Set up your VibeHub credentials

Initialize a Project

Start using VibeHub in your project

Getting Started

Core Commands

Sync Commands

Branch Commands

Overview

Requirements

Installation

Using npm (Recommended)

Using yarn

Verify Installation

First-Time Setup

Basic Commands

Quick Start Example

Getting Help

Command Help

List All Commands

Updating the CLI

npm

yarn

Uninstalling

npm

yarn

Troubleshooting

Command Not Found

Permission Errors

Node Version Too Old

Next Steps

Authentication

Initialize a Project

​Overview

​Requirements

​Installation

​Using npm (Recommended)

​Using yarn

​Verify Installation

​First-Time Setup

​Basic Commands

​Quick Start Example

​Getting Help

​Command Help

​List All Commands

​Updating the CLI

​npm

​yarn

​Uninstalling

​npm

​yarn

​Troubleshooting

​Command Not Found

​Permission Errors

​Node Version Too Old

​Next Steps

Authentication

Initialize a Project

Overview

Requirements

Installation

Using npm (Recommended)

Using yarn

Verify Installation

First-Time Setup

Basic Commands

Quick Start Example

Getting Help

Command Help

List All Commands

Updating the CLI

npm

yarn

Uninstalling

npm

yarn

Troubleshooting

Command Not Found

Permission Errors

Node Version Too Old

Next Steps