Documentation

Getting Started with ForgeSpacer

Welcome to ForgeSpacer. This guide will help you set up your workspace, understand the core concepts, and start generating product requirement documents and sprint plans using our AI engine.

Important Note

ForgeSpacer requires an active API key to utilize the AI generation features in your local environment. If you are using the cloud platform, this is handled automatically.

Quick Start Steps

1

Create your account

Sign up for a free ForgeSpacer account to get access to the dashboard and your default workspace.

2

Create your first project

Initialize a new project, select a template (Web App, Mobile App, API), and set your project goals.

3

Describe your idea

Use natural language to explain what you want to build. Our AI will ask clarifying questions if needed.

4

Generate documents

Click "Generate PRD" to watch the AI build out features, non-functional requirements, and user flows.

5

Organize sprints

Move your generated user stories into the Kanban board to plan your first development sprint.

6

Export & Share

Export your finished requirements to Markdown, PDF, or directly sync to Jira/Linear.

API Usage Example

You can interact with ForgeSpacer programmatically. Here's a quick example of how to generate a project summary using our REST API.

generate-project.ts
import { ForgeSpacerClient } from '@ForgeSpacer/sdk';

const client = new ForgeSpacerClient(process.env.ForgeSpacer_API_KEY);

async function main() {
  const project = await client.projects.create({
    name: "E-commerce Mobile App",
    description: "A React Native app for selling artisan coffee."
  });

  const prd = await client.ai.generatePRD(project.id, {
    detailLevel: "comprehensive",
    focus: ["performance", "offline-support"]
  });

  console.log('Generated PRD:', prd.documentUrl);
}

main();