Skip to content
Builderforce.ai Builderforce.ai BuilderForce Agents Docs

Getting Started

Getting Started

Section titled “Getting Started”

Goal: go from zero to a first working chat with minimal setup.

Fastest chat: open the Control UI (no channel setup needed). Run `builderforce dashboard` and chat in the browser, or open `http://127.0.0.1:18789/` on the gateway host. Docs: [Dashboard](/web/dashboard) and [Control UI](/web/control-ui).

Prereqs

Section titled “Prereqs”
  • Node 22 or newer
Check your Node version with `node --version` if you are unsure.

Quick setup (CLI)

Section titled “Quick setup (CLI)”
```bash curl -fsSL https://builderforce.ai/install.sh | bash ``` Install Script Process ```powershell iwr -useb https://builderforce.ai/install.ps1 | iex ``` 
<Note>
Other install methods and requirements: [Install](/install).
Built on [BuilderForce Agents](https://github.com/SeanHogg/Builderforce.ai)'s multi-channel gateway with Phase 2 enhancements.
</Note>
 ```bash builderforce onboard --install-daemon ``` 
The wizard configures auth, gateway settings, and optional channels.
See [Onboarding Wizard](/start/wizard) for details.
 If you installed the service, it should already be running: 
```bash
builderforce gateway status
```
 ```bash builderforce dashboard ``` If the Control UI loads, your Gateway is ready for use.

Optional checks and extras

Section titled “Optional checks and extras”
Useful for quick tests or troubleshooting. 
```bash
builderforce gateway --port 18789
```
 Requires a configured channel. 
```bash
builderforce message send --target +15555550123 --message "Hello from BuilderForce Agents"
```

Useful environment variables

Section titled “Useful environment variables”

If you run BuilderForce Agents as a service account or want custom config/state locations:

  • BUILDERFORCE_AGENTS_HOME sets the home directory used for internal path resolution.
  • BUILDERFORCE_AGENTS_STATE_DIR overrides the state directory.
  • BUILDERFORCE_AGENTS_CONFIG_PATH overrides the config file path.

Full environment variable reference: Environment vars.

BuilderForce Agents dev workflows (quick start)

Section titled “BuilderForce Agents dev workflows (quick start)”

Once your Gateway is running, initialize BuilderForce Agents in any project and start running multi-agent workflows.

```bash cd my-project builderforce init ``` 
This creates a `.builderforce/` directory with persistent project context:


```
.builderforce/
├── context.yaml    # project metadata (languages, frameworks, dependencies)
├── architecture.md # design docs
├── rules.yaml      # coding standards
├── agents/         # custom agent roles
├── skills/         # project-specific skills
├── memory/         # knowledge base
└── sessions/       # session handoff docs
```
 Run the **Planning workflow** before writing any code. It produces a PRD, architecture spec, and ordered task list. 
```bash
builderforce agent --message "Plan a real-time collaboration feature" --thinking high
```
 ```bash # Feature: Architecture Advisor → Code Creator → Test Generator + Code Reviewer builderforce agent --message "Implement the authentication module" --thinking high 
# Bug fix: Bug Analyzer → Code Creator → Test Generator + Code Reviewer
builderforce agent --message "Fix the memory leak in the parser" --thinking high


# Adversarial review (built-in critique pass):
builderforce agent --message "Adversarially review the API design" --thinking high
```
 At the end of each session, save a handoff so the next one resumes instantly. 
```bash
builderforce agent --message "Save a session handoff for today's work" --thinking low
```


BuilderForce Agents writes a structured YAML to `.builderforce/sessions/` covering decisions, next steps, and open questions. The next session loads it automatically.

Full workflow reference: BuilderForce Agents Workflows

Go deeper

Section titled “Go deeper”
Full CLI wizard reference and advanced options. First run flow for the macOS app.

What you will have

Section titled “What you will have”
  • A running Gateway
  • Auth configured
  • Control UI access or a connected channel

Next steps

Section titled “Next steps”