Installation Guide

Learn how to install and set up Gubus in your project

Installation Guide

Getting started with Gubus is quick and easy. Follow this guide to install and configure Gubus in your project.

Prerequisites

Before you begin, make sure you have the following installed:

  • Node.js (version 18 or higher)
  • npm or yarn package manager
  • Git for version control

Installation Methods

Method 1: Using npm

npm install gubus

Method 2: Using yarn

yarn add gubus

Method 3: Using pnpm

pnpm add gubus

Quick Setup

After installation, you can quickly set up Gubus in your project:

  1. Initialize Configuration

    npx gubus init

  2. Configure Environment Variables Create a .env file in your project root:

    GUBUS_API_KEY=your_api_key_here
GUBUS_ENVIRONMENT=development

  3. Start Development Server

    npm run dev

Verification

To verify that Gubus is installed correctly, run:

npx gubus --version

You should see the version number displayed in your terminal.

Next Steps

Now that you have Gubus installed, you can:

Troubleshooting

Common Issues

Issue: Command not found

  • Make sure you’ve installed Gubus globally or use npx
  • Check that your PATH environment variable includes npm binaries

Issue: Permission errors

  • Try using sudo on macOS/Linux (not recommended)
  • Better: Configure npm to use a different directory for global packages

Issue: Version conflicts

  • Clear your npm cache: npm cache clean --force
  • Delete node_modules and reinstall dependencies

Need more help? Contact our support team or check our FAQ section.