Getting Started

Here's a quick overview of the boilerplate.

Once you're done, start with

Playground to play around with agents.

Checkout the code from Github

1) In your terminal, run the following commands one-by-one:

terminal

1git clone https://github.com/agent-forge-org/agent-forge.git [YOUR_APP_NAME]
2cd [YOUR_APP_NAME]
3git remote remove origin

💡

AgentForge requires Node 18.17 or greater. Type node -vin your terminal to check version.

2) Rename.env.exampleto .env.local

terminal

1mv .env.example .env.local

3) Populate GROQ_API_KEY or OPENAI_API_KEY and the TAVILY_API_KEY

4) Run local dev server with:

terminal

1npm install
2npm run dev

5) Openhttp://localhost:3000and start playing around with agents.

App project structure

/ai → Everything related to AI: agents, workflows, etc.

/ai/agents → Agents

/app → Pages (1 folder + page.js = 1 page)

/app/api → API calls (1 file = 1 API endpoint)

/components → React components

/libs → Library functions

/scripts → Scripts for running commands locally

.env file

Rename the .env.example file to .env.local.

.env.local

1# -----------------------------------------------------------------------------
2# Groq: https://agentforge.app/docs/features/llm
3# -----------------------------------------------------------------------------
4GROQ_API_KEY=
5GROQ_MODEL_NAME=
6
7# -----------------------------------------------------------------------------
8# OpenAI: https://agentforge.app/docs/features/llm
9# -----------------------------------------------------------------------------
10OPENAI_API_KEY=
11OPENAI_MODEL_NAME=
12# -----------------------------------------------------------------------------
13# Tavily: https://agentforge.app/docs/features/tools
14# -----------------------------------------------------------------------------
15TAVILY_API_KEY=
16
17# -----------------------------------------------------------------------------
18# LangSmith: https://agentforge.app/docs/features/langsmith
19# -----------------------------------------------------------------------------
20LANGCHAIN_API_KEY=
21LANGCHAIN_TRACING_V2=true
22LANGCHAIN_PROJECT="Agent Forge Boilerplate"
23LANGCHAIN_CALLBACKS_BACKGROUND=true