← All guides

Publisher guide

Publishers are teachers, tutors and organisations who create Eduters bundles. You write each question as a simple text file, add your pictures and audio, check your work with the Eduter CLI tool, and send the bundle to Eduters. After a quick review, it goes live for learners.

1. Become a publisher

Email support@eduter.com to ask for a publisher account. Once approved, the Eduters team gives you:

• the Eduter CLI for your Windows computer (the eduter command),
• the address of the Eduters publishing service, and
• your publisher key.

Keep your key private. It works like a password for publishing. Don't email it on, put it in a shared folder, or save it inside a bundle. If you think someone else has seen it, ask us to replace it. The old key then stops working straight away.

2. Connect the Eduter CLI

Open a terminal (for example Windows Terminal or PowerShell) and save your connection once. prod is a name you choose for this connection:

eduter publisher init --target prod --api-url <service-address> --api-key <your-publisher-key>

The connection is saved for your Windows user only. To review or edit it later, run eduter config. Run eduter help at any time to list every command.

To keep the Eduter CLI up to date, run eduter update. It shows, in green, the command to copy and run.

3. Create a new bundle

Every bundle must be created by the Eduter CLI. It gives the bundle its unique bundle key and sets up the folder correctly. Go to your bundle content folder and run:

eduter create

The Eduter CLI prints the new key, for example 12-AB12CD, and opens its folder:

Don't create or rename bundle folders by hand. Always start a new bundle with eduter create and keep working in the folder it made. To add more question files later, run eduter ap <bundle-key>.

4. Describe your bundle

Open ____.md and fill in the details learners will see on the bundle card and page:

# Counting to 20

![cover](assets/cover.png)

_Name:_ Counting to 20
_Title:_ Counting to 20
_SubTitle:_ Count objects, then pick the number
_Description:_ Ten friendly counting questions with pictures.
_Tags:_ maths, counting, kids
_SessionMode:_ VerifyOnTheGo
_FontProfile:_ TamilFriendly

The Eduters team sets the category, level and duration when they review your bundle.

5. Write your questions

Each numbered file is one question. Keep the lines the Eduter CLI created at the top (such as _Ukey:_); they identify the question.

# How many apples?

- Count the apples in the basket.
- Pick the right number.

![basket](assets/apples.png)

## QuestPanel

## AnswerPanel
SelectOne
- 6
- 7
- 8
- 9

## Answer
- 7

## Solution
- There are 7 apples: count them one by one.

You can write maths with LaTeX between dollar signs, for example $\frac{2}{5}$.

Answer panels

A picture-choice example:

## QuestPanel
Audio
- Listen: assets/prompt.mp3

## AnswerPanel
PictureChoice
- tree: assets/tree.png
- mango: assets/mango.png
- boat: assets/boat.png
- kolam: assets/kolam.png

## Answer
- tree

For listening questions, put an MP3 file in assets and add an Audio helper. Don't put the answer in the audio label.

6. Check and build

Run these from your bundle content folder, using your bundle key:

eduter validate 12-AB12CD
eduter build 12-AB12CD

Validate checks your bundle details and every question file: each question needs text and answers that fit its answer panel, and every picture must exist in assets. It stops at the first question with a problem and lists what to fix. Fix it, then run the command again. Build turns your files into the package that is sent to Eduters.

7. Publish

eduter publish 12-AB12CD --target prod

The Eduter CLI checks your key, validates and builds again, then uploads the bundle with its pictures and audio. It shows the target and folder it is using, so you can confirm you are publishing the right bundle to the right place.

Your bundle is now Awaiting approval. Learners can't see it yet. The Eduters team reviews it and, once approved, it appears in the portal.

8. Update a published bundle

1. Edit the files in the same bundle folder.
2. Run eduter publish <bundle-key> --target prod again.

Every update is reviewed again before learners see it. To replace a picture, keep the same file name and path. Learners who already started a session may keep the settings they began with.

Quality checklist

• The cover picture is clear and suits the age group.
• Every question has short, clear text a learner can read on a phone.
• Pictures describe the answer without relying on words inside the image.
• Picture-choice questions have four clearly different pictures.
• Every Practice question has a helpful ## Solution.
• Audio is clear, and does not give away the answer in its label.
• eduter validate runs with no errors.

Troubleshooting