Installation
Get Cineyma up and running in your Rust project.
Prerequisites
Before installing Cineyma, make sure you have:
- Rust 1.75+ — Cineyma uses async/await and modern Rust features
- Tokio runtime — Cineyma is built on Tokio for async execution
Check your Rust version with rustc --version
Basic Installation
Add Cineyma to your project using Cargo:
Or add it manually to your Cargo.toml:
Cargo.toml
toml1
2
Setting up with Tokio
Cineyma requires the Tokio runtime. Here's a minimal setup:
Cargo.toml
toml1
2
3
Then use the #[tokio::main] attribute on your main function:
main.rs
rust1
2
3
4
5
6
7
8
9
10
Feature Flags
Cineyma provides optional features that can be enabled in your Cargo.toml:
| Feature | Description | Default |
|---|---|---|
remote | Enable remote actor messaging over TCP | No |
cluster | Enable clustering with gossip protocol | No |
full | Enable all features | No |
Cargo.toml
toml1
2
3
4
5
6
7
8
9
Verify Installation
Create a simple test to verify everything is working:
main.rs
rust1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
Run with cargo run. You should see:
Next Steps
Now that you have Cineyma installed, continue with: