Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 1.44 KB

getting-started.md

File metadata and controls

63 lines (46 loc) · 1.44 KB

Getting Started

Cyphra CLI is the standalone application repository for:

  • the rse command-line interface
  • the workflow DSL runtime
  • corpus evaluation and probe tooling
  • the experimental TUI frontend

It depends on an installed RoadscriptEngine package.

Prerequisite

If you have access to the private Roadscript Engine repository, install it first and note the resulting CMake package directory.

Example:

cmake -S /path/to/roadscript-engine -B /path/to/roadscript-engine/build \
  -DCMAKE_BUILD_TYPE=Release \
  -DCMAKE_INSTALL_PREFIX=/path/to/roadscript-engine/install
cmake --build /path/to/roadscript-engine/build
cmake --install /path/to/roadscript-engine/build

Configure and Build

cmake -S . -B build \
  -DCMAKE_BUILD_TYPE=Release \
  -DRoadscriptEngine_DIR=/path/to/roadscript-engine/install/lib/cmake/RoadscriptEngine
cmake --build build

The local CLI binary will be:

./build/rse

First CLI Run

Classic is the stable default protocol family and the best starting point for a first run.

./build/rse embed \
  --protocol classic \
  --in tests/fixtures/input/input.jpg \
  --out ./rse_classic.png \
  --msg-block "hello roadscript"

./build/rse verify \
  --protocol classic \
  --in ./rse_classic.png

Next Steps