Getting Started

Froid can help you plan and build anything from a small bug fix to a project with a million lines of code. Let’s start with something small.

Already have a repository and a small change you want to make? Install Froid there, open your coding tool in the repository, and run the installed froid-build skill. Talk to it about the change you want, and it will make it happen.

Otherwise, start here. You will make a working Python program in an empty project. This tutorial follows the one-session planning path: one coherent request goes directly to the froid-build skill.

Before You Start

Use a macOS or Linux shell with Node.js 20.12+, Python 3, and a coding tool supported by Froid. The exact install and launch commands below are for Claude Code. If you use another supported tool, select it when installing Froid and run the froid-build skill there instead.

Create an Empty Project

mkdir froid-first-project
cd froid-first-project

Install the current stable version of MaxwellAI OS Froid. This command sets it up for Claude Code:

npx maxwellai-froid install --directory . --modules froid --tools claude-code --yes

Open your coding tool in this directory. For Claude Code, run:

claude

Build a Mars Rover

Ask the froid-build skill to make the Mars Rover programming kata, a small exercise used to practice coding, without adding any design choices:

/froid-build write an implementation of mars rover kata

This gives the froid-build skill room to ask what you want. It may start with a question like this:

`froid-build`: Before implementation, I need one choice: which language should I use?
You: Python 3. Make it a small old-school terminal program I can run locally,
with no dependencies beyond Python standard library.

Your questions, answers, plan, and finished program may differ. Choose the behavior you want rather than copying the example answer.

After you answer its questions, read its plan. Approve it or ask for changes. The skill then writes the program, checks its work, fixes any problems, and shows you what changed.

Run the Mars Rover

Depending on what you told it, the result may look something like this:

python3 mars_rover.py --size 5x5 --obstacle 2,2

Enter FFRFF, then MAP, then QUIT. The terminal shows the rover stopping before the obstacle:

MARS ROVER CONTROL
Commands: F/M forward, B backward, L/R turn, MAP, STATUS, HELP, QUIT
Position: (0, 0)  Heading: N
rover> Position: (1, 2)  Heading: E
OBSTACLE: movement blocked at (2, 2)
rover>  4  . . . . .
 3  . . . . .
 2  . > # . .
 1  . . . . .
 0  . . . . .
    0 1 2 3 4
rover> Mission control signing off.

Open the files listed in the final message to look at your finished program.

Ask Froid Help

The froid-help skill answers questions about Froid. Use it to understand what happened, decide what to do next, or solve a problem. Try it now:

/froid-help Explain what froid-build just did.

You Built It

Mars Rover showed how the froid-build skill turns a short request into working software. It clarified the request, presented a plan for your approval, wrote the program, and checked its work before showing you the result.

Keep Building

1. Install Froid in your own repository, then run the froid-build skill with a short description of a small change. See Build a Change for the attended path.
2. Continue to Getting Deeper for a small change in a mature codebase, followed by a larger change using a written spec.
3. Use Choose a Planning Path when your next change may need several implementation sessions or multiple epics.