Skip to content

Getting started

Install the package

Use a virtual environment in real projects:

python -m venv .venv
source .venv/bin/activate  # Windows: .venv\\Scripts\\activate
pip install rubikoslav

uv init
uv add rubikoslav

Published wheels include the compiled native extension, so normal installs on supported platforms do not need CMake or a C++ compiler.

Open the visualizer

rubikoslav

The command starts the local solver and opens the visual cube. To keep the browser closed:

rubikoslav --no-open

Solve from the terminal

rubikoslav solve "R U R' U'"

Common commands

Command What it does
rubikoslav Opens the local visualizer.
rubikoslav --no-open Starts the app without opening a browser.
rubikoslav --port 8080 Uses another local port.
rubikoslav solve "R U F2" Solves a scramble from the terminal.
rubikoslav doctor Checks the native module, solver, and web files.
rubikoslav doctor --strict Performs and replays a real solve.

Move notation

Rubikoslav uses standard face letters: U, D, L, R, F, and B.

  • R means one quarter turn.
  • R2 means a half turn.
  • R' means the reverse quarter turn.

Check the installation

rubikoslav doctor --strict

The strict check loads the native module, finds the packaged web files, performs a real solve, and replays the answer through C++.

First-solve cache

Optimal search uses generated transition and pruning tables. Rubikoslav stores them under the operating system's normal cache location. Override it when needed:

export RUBIKOSLAV_CACHE_DIR=/absolute/path/to/cache
rubikoslav doctor --strict