AgileBuilder logoAgileBuilder
Back to docs

Quick Start

5-minute guide to AgileBuilder core workflow

This guide will help you install AgileBuilder and generate your first project in 5 minutes.

Install AgileBuilder

Install AgileBuilder CLI globally via npm:

npm install -g agilebuilder

After installation, verify it with:

agilebuilder --version

Start Local UI

Run the following command to start the local management interface:

agilebuilder ui

Your browser will automatically open http://localhost:3456, where you'll see the AgileBuilder management interface.

The local UI works offline, with all data stored locally.

Add Template

Add your first project template in the UI. You can add templates in the following ways:

Import from Git Repository

agilebuilder template add https://github.com/your-org/your-template.git

Create from Existing Project

agilebuilder template create ./my-existing-project --name my-template

Templates support variables and conditional rendering. See Template Tutorial for details.

Generate Project

Select a template, fill in variables, and generate a new project:

agilebuilder generate <template-name> <project-name>

For example:

agilebuilder generate react-starter my-new-app

The generated project will automatically execute configured hooks (like installing dependencies, initializing Git, etc.).

Next Steps