ドキュメント
スタートガイド

スタートガイド

このガイドでは、JUMONをすぐに使い始めるための手順を説明します。インストール方法、最初のモジュールの作成、実行方法について解説します。

インストール

前提条件

  • Go 1.24以降
  • Git（リモートモジュールのインポートに必要）
  • AI APIキー
    • OpenAI: OPENAI_API_KEY
    • Google: GOOGLE_API_KEY
    • Anthropic: ANTHROPIC_API_KEY

JUMONのインストール 

# JUMONのインストール
go install github.com/jumonapp/jumon@latest

# インストールの確認
jumon version

JUMONサーバーの起動

JUMONはクライアント-サーバーアーキテクチャを採用しています。モジュールを実行する前に、サーバーを起動する必要があります。

# サーバーの起動
jumon serve

# サーバーはバックグラウンドで実行されます

最初のモジュールの作成

簡単な「Hello World」モジュールを作成してみましょう。

  1. モジュール用の新しいディレクトリを作成します：
mkdir hello-jumon
cd hello-jumon
  1. 新しいJUMONモジュールを初期化します：
jumon init hello-jumon

これにより、基本的なモジュール構造を持つJUMON.mdファイルが作成されます。

  1. JUMON.mdファイルを編集します：
---
module: hello-jumon
---

## スクリプト

### main

1. アメリカンジョークを一つ作って
2. ジョークの原語と翻訳とともに解説して

モジュールの実行

では、モジュールを実行してみましょう：

jumon run .

アメリカンジョークの真髄を学べました。

サーバーの停止

作業が終わったら、JUMONサーバーを停止できます：

jumon stop
アーキテクチャ