Quick Start (Local Edition)
Get started with AgileBuilder Local Edition in 5 minutes
This guide will help you get AgileBuilder Local Edition installed and generate your first project in 5 minutes. The local edition is completely free and doesn't require an account.
Step 1: Install AgileBuilder
If you haven't installed it yet, install the AgileBuilder CLI first:
npm install -g agilebuilder
Verify the installation:
agilebuilder --version
Step 2: Launch the Local Interface
Start the local management interface:
agilebuilder ui
The browser will automatically open http://localhost:3456, where you'll see AgileBuilder's local management interface.
The local UI works offline. All data (templates, project configurations) is stored on your computer.
Step 3: Add a Template
Add your first project template through the local interface:
Import from a Git Repository
agilebuilder template add https://github.com/your-org/your-template.git
Create from an Existing Project
If you have an existing project on your machine, you can convert it to a template:
agilebuilder template create ./my-existing-project --name my-template
Use Built-in Templates
AgileBuilder includes built-in templates for quick experimentation.
Step 4: Generate a Project
Select a template, fill in the variables, and generate a new project with one command:
agilebuilder generate <template-name> <project-name>
For example:
agilebuilder generate react-starter my-new-app
With variables:
agilebuilder generate react-starter my-new-app \
--var projectName=my-new-app \
--var useTypeScript=true
Common Operations
List Templates
agilebuilder template list
View Template Details
agilebuilder template info <template-name>
Remove a Template
agilebuilder template remove <template-name>
Next Steps
- Project Scaffolding - Learn more about project generation
- Template System - Learn about template management and configuration
- Template Getting Started - Learn how to create custom templates