Get Started

This guide will help you get started with JUMON quickly. We’ll cover installation, creating your first module, and running it.

Installation

Prerequisites

• Go 1.24 or later
• Git (for importing remote modules)
• AI API Key
  • OpenAI: OPENAI_API_KEY
  • Google: GOOGLE_API_KEY
  • Anthropic: ANTHROPIC_API_KEY

Install JUMON

# Install JUMON
go install github.com/jumonapp/jumon@latest

# Verify installation
jumon version

Starting the JUMON Server

JUMON uses a client-server architecture. You need to start the server before running any modules.

# Start the server
jumon serve

# The server will run in the background

Creating Your First Module

Let’s create a simple “Hello World” module.

1. Create a new directory for your module:

mkdir hello-jumon
cd hello-jumon

2. Initialize a new JUMON module:

jumon init hello-jumon

This will create a JUMON.md file with a basic module structure.

3. Edit the JUMON.md file:

---
module: hello-jumon
---

## Scripts

### main

1. How is JUMON written in kanji?
2. Explain the meaning along with its kanji

Running Your Module

Now let’s run the module:

jumon run .

You will understand the meaning of the 呪文.

Stopping the Server

When you’re done, you can stop the JUMON server:

jumon stop