Quick Start

Note

The scl-machine can't be used on Windows.

Use scl-machine as an extension to sc-machine

Download pre-built artifacts of sc-machine from GitHub Releases and extract it to any location.

To learn more about how to install and use sc-machine artifacts, see sc-machine quick start.
Download pre-built artifacts of scl-machine from GitHub Releases and extract it to any location.

Then specify the folder path to lib/extensions from extracted scl-machine folder when running the sc-machine binary:

./path/to/extracted/sc-machine/binary -s path/to/kb.bin \
    -e "path/to/extracted/scl-machine/lib/extensions;path/to/extracted/sc-machine/lib/extensions"
# if several paths to extensions are provided then they should be separated 
# by semicolon and wrapped in double quotes

Use scl-machine as a C++ library in your project

Conan

You can use Conan to install scl-machine. To integrate scl-machine into your project using Conan, follow these steps:

Create a conanfile.txt in your project root with the following content:
```
[requires]
scl-machine/<version>
```
Install pipx first using guide: https://pipx.pypa.io/stable/installation/.
Install Conan if not already installed:
```
pipx install conan
pipx ensurepath
```
Update CMake to 3.24:
```
pipx install cmake
pipx ensurepath
```
Relaunch your shell after installation.
```
exec $SHELL
```

Add the OSTIS-AI remote Conan repository:

conan remote add ostis-ai https://conan.ostis.net/artifactory/api/conan/ostis-ai-library

Install scl-machine and its dependencies:
```
conan install . --build=missing
```
Import scl-machine targets into your CMake project by using:
```
find_package(scl-machine REQUIRED)
```

Link scl-machine::inference target to your target:

target_link_libraries(my-module
    LINK_PUBLIC scl-machine::inference
)

Go to problem solver documentation to learn how to use scl-machine agents.

In case you want to make changes to the project sources, please refer to the build system docs.