Quick Start Guide

Get up and running with DevHub CLI in minutes. This guide will walk you through creating your first project.

Creating Your First Project

1. Open your terminal and navigate to where you want to create your project

2. Run:

devhub create

You'll see the DevHub CLI welcome screen and be prompted to:

• Enter a project name

• Select a project template

• Configure template-specific options

Project Creation Flow

1. Project Name

? What is your project name? my-first-project

Enter a name for your project. The name should:

• Only contain letters, numbers, underscores, and hashes

• Be descriptive and easy to remember

• Not contain spaces

2. Template Selection

? What project template would you like to use?
  ❯ HTML/CSS - Simple website
    React - Modern web application
    Electron - Desktop application
    FiveM - GTA V multiplayer resource
    RedM - Red Dead Redemption 2 multiplayer resource

Use arrow keys to select your template and press Enter.

3. Template-Specific Options

For HTML/CSS Projects

? Select CSS frameworks: (Use ↑↓ to move, Space to select, Enter to confirm)
  ❯ ◯ Pure CSS
    ◯ Tailwind CSS
    ◯ Bootstrap
    ◯ Sass/SCSS

? Select meta tags: (Use ↑↓ to move, Space to select, Enter to confirm)
  ❯ ◯ SEO Optimization
    ◯ Social Media Tags

For Electron Projects

? Select Electron features: (Use ↑↓ to move, Space to select, Enter to confirm)
  ❯ ◯ Frameless Window
    ◯ Custom Title Bar
    ◯ Auto Updater
    ◯ Custom Installer

For Vue.js Projects

? Select Vue.js features: (Use ↑↓ to move, Space to select, Enter to confirm)
 ❯ ◯ TypeScript
   ◯ Vue Router
   ◯ Pinia State Management
   ◯ Unit Testing

What Happens Next?

DevHub CLI will:

1. Create the project structure in your current directory

2. Install all necessary dependencies (for HTML, React, and Electron projects)

You'll see progress indicators for each step:

✔ Project structure created
✔ Dependencies installed

Running Your Project

After creation, for HTML, React, and Electron projects:

1. Navigate to your project directory:

cd my-first-project

1. Start the development server:

npm run dev

or

npm start

For FiveM and RedM resources:

• The resource will be created in your current directory

• Copy the resource to your server's resources folder

• Add it to your server.cfg

Tips & Tricks

• Use the spacebar to select multiple options in the checkbox prompts

• Press Tab to auto-complete project names in the terminal

• Use arrow keys to navigate through previous commands

• The CLI will automatically check for updates when you run commands