How to use CLI_Timer

This page is here to show how to use this program.
This assumes you have CLI_Timer installed (as "CLI_Timer")
You must run this program in a terminal emulator.

Contents

1. List of arguments
   1. Puzzle arguments
   2. Event modifiers
   3. Additional options
2. Being prompted
3. Example commands

List of arguments

These all go after $ CLI_Timer

Puzzle arguments

2 -> Generates a scramble for a 2x2 3 -> Generates a scramble for a 3x3 4 -> Generates a scramble for a 4x4 5 -> Generates a scramble for a 5x5 6 -> Generates a scramble for a 6x6 7 -> Generates a scramble for a 7x7

S -> Generates a scramble for a Skewb P -> Generates a scramble for a Pyraminx M -> Generates a scramble for a Megaminx C -> Generates a scramble for a Clock Q -> Generates a scramble for a Square-1

Event modifiers

-b -> Generates a blindfolded scramble. Requires: 3, 4 or 5. -f -> Generates an FMC scramble. Requires: 3

Additional options

help -> Outputs help message. --version -> Outputs the version + changelog.

The ones below all need to have a puzzle given somewhere in the command.

c -> Continually generates scrambles until exited.

-s{file_name} -> Saves scrambles, times, penalties and comments to a file called {file_name}.CLI_T_S (CLI_Timer_Session) in a path dependant in your OS.

--count{number} -> Generates {number} scrambles then automatically exits.

--no_prompt -> Doesn't prompt user for a time. Will be ignored with -s --no_enter -> Requires: --count because it generates scrambles until it reaches the number specified in --count. Ignores c.

--no_avg -> Hides the averages.

Being prompted

Once you have run a command, you will see something in the terminal that looks like this:

$ CLI_Timer 3

L2 U B' F' R2 U2 L2 
U' B' R B' R U R' B
F U' F2 D2 U2                                          Current mean: 0:00:00.00  
                                                        Current ao5: 0:00:00.00      
                                                       Current ao12: 0:00:00.00
                                                       Current ao50: 0:00:00.00  
                                                      Current ao100: 0:00:00.00  
  
Enter your time:

So now you will want to put in the time you got (probably measured with a stackmat timer). You can input it as 00:00:12.34 however you do not need the 0's, so you can type in 12.34. Nor the ":"s and the "." as the program will automatically insert it, so you can also type in 1234. If you solved it in 1 minute, 23.45 seconds, you can enter 1:23.45 or 12345.

Then you will be see:

Enter your time: 1234

You entered in 12.34 (which is also 12.34 seconds)  
Is this correct? (Y/n)

If you type Y, y or just press enter, it'll accept the time otherwise otherwise it'll re-ask it.

Then you will see:

Is this correct? (Y/n)
Y

Enter an penalty (OK/+2/dnf)

If you were 1 move off solving the cube when you finish timing, type in +2. If you were more than 1 move off then enter in DNF (or dnf). Otherwise type in OK, ok or nothing. If you enter something else it'll re-ask.

If you are saving to a file, you will see:

Enter an penalty (OK/+2/dnf)
OK
Enter in a comment (or don't you can leave blank)

You can or can't enter in a comment on the solve.

Example commands

All of the above arguments can be applied in any order.

$ CLI_Timer 5 -> Generates a single 5x5 scramble.

$ CLI_Timer 3 c -> Generates 3x3 cube scrambles until "quit" is given as a "time".

$ CLI_Timer 4 -B -> Generates a single 4BLD scramble.

$ CLI_Timer 6 -s"6x6_ao5" --count5 -> Generates 5 6x6 scrambles and saves it to a file called "6x6_ao5.CLI_T_S".

$ CLI_Timer P --no_prompt --no_avg c -> Continually generates Pyraminx scrambles without displaying the averages between the user pressing enter (or return). You can type save if you want to save to file at any point.

$ CLI_Timer S --count25 --no_prompt --no_enter --no_avg -> Just outputs 25 Skewb scrambles.