Chapter 1 of 14

Getting started

Install Creole before you begin.

Creole is a readable programming language that helps you build your own programs without first learning a complex language. Its instructions use short, familiar words, so you can focus on what your program should do.

Start small. Write one instruction, run it, and then add the next instruction.

What you will learn

In this guide, you will:

  • install Creole on Windows
  • create your first .crlo file
  • show text in the terminal
  • ask a person for input
  • check code without running it
  • run one file or a complete project

Install Creole

  1. Open the Creole download page.
  2. Download the current Windows installer.
  3. Open the installer and follow the steps.
  4. Open a new terminal after installation finishes.

Check that Creole is ready:

creole --version

If the terminal shows the installed version, you are ready to write Creole code.

Open a new terminal after installation. A terminal that was already open may not find the newly installed creole command.

Create your first program

Create a folder named hello-creole. Inside that folder, create a file named hello.crlo.

Creole source files always use the .crlo extension.

Add this instruction:

Show "Hello from Creole".

Save the file, open a terminal in the same folder, and run:

creole hello.crlo

The terminal will show:

Hello from Creole

You have now made and run your first Creole program.

Understand the instruction

The first program has three simple parts:

  • Show tells Creole to display something.
  • "Hello from Creole" is the text to display.
  • The final period completes the instruction.

Creole words are designed to make the purpose of an instruction clear. You do not need braces, semicolons, or JSON symbols to show text.

Ask for input

Programs can ask a person for information and save the answer under a name.

Replace the content of hello.crlo with:

Ask "What is your name? " and store the answer in name.
Show "Hello, " followed by name.

Run the file again:

creole hello.crlo

The program asks for a name and then uses the saved answer in its message.

The name name is a value your program can use again. Choose short names that explain what each value contains.

Add more instructions

Creole reads instructions in order, from the top of the file to the bottom.

Show "Welcome to Creole".
Ask "What are you building? " and store the answer in project.
Show "You are building " followed by project.
Show "Your program is ready to grow.".

Each instruction performs one clear step. This makes a program easier to read, change, and check.

Check before running

Use the checker when you want to find code problems without running the program:

creole --check hello.crlo

Checking first is useful when a program will read files, call an API, or run other work.

A simple workflow is:

  1. write a small change
  2. save the file
  3. check the file
  4. run the file
  5. confirm the result

Start a project

A single .crlo file is enough for a small program. For a larger program, create a project folder with an @.crlo file.

The @.crlo file is the main project-information file. From inside a folder containing it, run the complete project with:

creole run

You will learn how to organize project folders and connected modules in the next guide.

Common first problems

The command is not found

Close the terminal, open a new one, and try:

creole --version

If the command is still unavailable, install Creole again from the official download page.

The file does not run

Confirm that:

  • the file name ends in .crlo
  • the terminal is open in the folder containing the file
  • the file was saved before you ran it
  • the command contains the correct file name

The checker reports a problem

Read the first message, open the named line, and correct that instruction. Check the file again before running it.

Do not ignore a problem by deleting useful code. Make one small correction at a time.

Good habits

  • Use clear file and value names.
  • Keep one instruction focused on one action.
  • Check a program after each meaningful change.
  • Keep API keys and private tokens out of .crlo files.
  • Use environment values for private developer settings.
  • Keep @.crlo in the main project folder.

Complex symbols make code better. Clear instructions make code easier to understand and maintain.

Quick practice

Create practice.crlo and complete these steps:

  • Show a welcome message.
  • Ask for the person's name.
  • Save the answer in name.
  • Show a message that includes name.
  • Check the file with creole --check practice.crlo.
  • Run the file with creole practice.crlo.

Next step

You now know how to install Creole, create a .crlo file, show text, receive input, check code, and run a program.

Continue to Command Line first, to learn how use creole's CLI.