Getting Started

Pick your environment and get something running.

All examples use the same Stof document.

The Example

Save this as hello.stof:

str message: "Hello, Stof!"

fn greet() -> str {
    `${self.message} Data and logic, together.`
}

#[main]
fn main() {
    pln(self.greet());
}

/* Output:
Hello, Stof! Data and logic, together.
*/

---

CLI

Install:

cargo install stof-cli

Don't have Rust? Install it here - cargo comes with it.

Run:

stof run hello.stof

VS Code user? Search "Stof" in the extensions tab for syntax highlighting.

---

TypeScript

Install:

npm i @formata/stof

Run:

import { initStof, StofDoc } from '@formata/stof';
await initStof();

const doc = new StofDoc();
doc.lib('Std', 'pln', (...args: unknown[]) => console.log(...args));
doc.parse(`
    str message: "Hello, Stof!"

    fn greet() -> str {
        \`\${self.message} Data and logic, together.\`
    }

    #[main]
    fn main() {
        pln(self.greet());
    }
`);
await doc.run(); // Hello, Stof! Data and logic, together.

---

Python

Install:

pip install stof

Run:

from pystof import Doc

doc = Doc()
doc.parse("""
    str message: "Hello, Stof!"

    fn greet() -> str {
        `${self.message} Data and logic, together.`
    }

    #[main]
    fn main() {
        pln(self.greet());
    }
""")
doc.run()
# Hello, Stof! Data and logic, together.

---

Rust

Add to Cargo.toml:

[dependencies]
stof = "0.9.*"

Run:

use stof::model::Graph;

fn main() {
    let mut graph = Graph::default();

    graph.parse_stof_src(r#"
        str message: "Hello, Stof!"

        fn greet() -> str {
            `${self.message} Data and logic, together.`
        }

        #[main]
        fn main() {
            pln(self.greet());
        }
    "#, None).unwrap();

    graph.run(None, true).unwrap();
    // Hello, Stof! Data and logic, together.
}

---

What's next?

• Try the playground — no install required

• Core Concepts — understand how Stof works

• Schemas — self-validating data

• Async — parallel execution