Chapter 2 of 14

Command line

The Creole command-line tool runs programs, opens projects, checks source code, formats code, manages updates, and passes values into a program.

After installing Creole, open a new terminal and run:

creole --help

This displays the public commands supported by the installed version.

Creole programs use .crlo source files. Run commands from a terminal such as Windows Terminal, PowerShell, or Command Prompt.

Show the installed version

creole --version

The command prints the installed language version:

Creole x.y.z

The numbers show your installed version.

Show command help

Run Creole without a file or option:

creole

Or request help directly:

creole --help

The help screen lists the source-file input, program arguments, and supported public options.

Run one program

Open a terminal in the folder containing your file:

creole hello.crlo

Creole reads, checks, and runs hello.crlo.

Example file:

Show "Hello from Creole".

You can also provide a path:

creole examples/hello.crlo

On Windows, a path containing spaces should be placed inside quotes:

creole "My Programs/hello.crlo"

Run a project

A Creole project contains an @.crlo project-information file.

Open a terminal inside the project folder and run:

creole run

Creole uses the current folder, loads @.crlo, finds the declared starting file, and prepares these project values:

  • project name
  • project folder
  • project data folder

You can also give Creole a project folder directly:

creole "C:/Projects/my-project"

The folder must contain a valid @.crlo file.

Pass arguments to a program

Write values after the source file:

creole report.crlo reports daily

Read them inside the program:

Use first argument as folder.
Use second argument as mode.
Show argument count.
Show folder.
Show mode.

Everything after the program file is passed to the Creole program in the same order.

Use quotes when one argument contains spaces:

creole greet.crlo "Asha Patel"

Do not place private API keys directly in command history. Use environment values or approved secret storage.

Check code without running it

creole --check program.crlo

The checker validates the source without executing the program.

A successful check prints a message similar to:

Creole checked program.crlo: no syntax problems found.

When a problem is found, Creole can report:

  • an error code
  • the file name
  • the line and column
  • the original source instruction
  • an explanation
  • a suggested correction

The command returns a failure exit status when syntax problems are present. This makes it useful in automated checks.

Check a project

You can check a project folder:

creole --check "C:/Projects/my-project"

Creole loads the project and checks its declared starting file.

Format source code

creole --format program.crlo

This prints the safely formatted source to the terminal.

It does not replace the original file automatically. Review or redirect the output yourself when appropriate.

For example, print the formatted result into another file:

creole --format program.crlo > formatted.crlo

Check the new file before replacing important source code:

creole --check formatted.crlo
Do not redirect formatted output back into the same source file in one command. The terminal may empty the file before Creole reads it.

Check for an update

creole --check-update

Creole contacts the official update service and reports whether a newer version is available.

This option cannot be combined with a program file.

Incorrect:

creole --check-update hello.crlo

Correct:

creole --check-update

Install an update

creole --update

On Windows, Creole:

  1. reads the official release information
  2. downloads the latest installer
  3. applies a safe download-size limit
  4. verifies the downloaded size
  5. verifies the installer checksum
  6. opens the verified installer

The installer is not opened if verification fails.

--update cannot be combined with a program file.

Automatic update notices

When a normal public command starts, Creole may perform a short update check.

If a newer version is available, it shows a small notice before continuing. An unavailable update server does not stop the program.

Use this command when you are ready to update:

creole --update

Frontend request mode

Creole includes a request mode for controlled frontend or server integration:

creole --request application.crlo

It reads one frontend request as JSON from standard input, runs the Creole application, and writes one compact JSON response to standard output.

This is an advanced integration command. Normal .crlo programs do not need it.

Keep the request pipeline controlled by the application developer. Validate incoming data and never expose private provider settings or company data.

Exit results

Creole uses process exit results that automation tools can understand:

  • 0 means the command completed successfully
  • 1 means checking, loading, updating, or running stopped with a problem
  • argument errors display command usage and return a command-line failure

This allows build scripts and other tools to stop when a Creole check fails.

Common command errors

No program was provided

Running creole by itself displays help. To run a file, include its name:

creole hello.crlo

The source extension is incorrect

Creole source files use .crlo:

hello.crlo

A folder is accepted only when it is a Creole project containing @.crlo.

The terminal cannot find Creole

Close the current terminal, open a new one, and run:

creole --version

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

A file path contains spaces

Wrap the complete path in quotes:

creole "C:/My Programs/app.crlo"

creole run cannot find the project

Confirm that:

  • the terminal is inside the project folder
  • the folder contains @.crlo
  • @.crlo declares an existing starting file

A program argument starts with a dash

Arguments after the source file belong to the program because Creole collects the remaining values. Keep command options before the source file when using a Creole option.

Command reference

General commands

creole
creole --help
creole --version

Run code

creole program.crlo
creole program.crlo first second
creole run
creole "C:/Projects/my-project"

Check and format

creole --check program.crlo
creole --format program.crlo

Updates

creole --check-update
creole --update

Advanced integration

creole --request application.crlo

Safe command-line habits

  • Check unfamiliar code before running it.
  • Put paths containing spaces inside quotes.
  • Keep tokens and passwords out of terminal history.
  • Review formatted output before replacing a source file.
  • Use the official update command and verified installer.
  • Test project commands with non-sensitive data first.
  • Read the first reported error before changing multiple lines.

Command-line checklist

  • I can display help and the installed version.
  • I can run one .crlo file.
  • I can run a project with creole run.
  • I can pass ordered arguments into a program.
  • I can check source without running it.
  • I understand that --format prints the result.
  • I can check for and install verified updates.
  • I know that --request is for advanced integration.
  • I can quote a path containing spaces.
  • I keep private values out of terminal history.

Keep learning

Use creole --help as the command-line reference for your installed version. New public commands will appear there as the Creole CLI grows.

Continue to Project folders to learn how @.crlo, connected modules, and creole run work together.