Getting Started
Installation
Install Sysplant from PyPI or run from source.
Installation
Prerequisites
| Dependency | Version | Purpose |
|---|---|---|
| Python | >= 3.10 | Runtime |
| pip / Poetry | latest | Package management |
Optional dependencies
| Dependency | Version | Purpose |
|---|---|---|
sysplant[mcp] | — | MCP server for AI coding assistants |
MinGW (mingw-w64) | latest | Cross-compile C / C++ output from Linux |
| Nim | >= 2.0 | Compile NIM output |
Rust + x86_64-pc-windows-gnu | latest | Compile Rust output |
From PyPI
pip install sysplant
This installs the sysplant CLI and the sysplant Python library. The MCP server bridge (bridge_mcp_sysplant.py) is not included in the PyPI package — run Sysplant from source if you need it.
With MCP support
pip install "sysplant[mcp]"
This adds the mcp and fastmcp dependencies required to run the Model Context Protocol server.
As a Poetry dependency
poetry add sysplant
With MCP support:
poetry add "sysplant[mcp]"
From source
git clone https://github.com/x42en/sysplant.git
cd sysplant
pip install .
Or with Poetry:
poetry install
For MCP support from source:
poetry install --with mcp
# or
pip install ".[mcp]"
Verify
sysplant --help
You should see the top-level help with list and generate subcommands.
Cross-compiler toolchains
Sysplant generates source files for Windows targets. You will still need appropriate toolchains installed on your build host:
| Language | Toolchain |
|---|---|
| C | x86_64-w64-mingw32-gcc (mingw-w64) |
| C++ | x86_64-w64-mingw32-g++ (mingw-w64) |
| NIM | nim + mingw target (-d=mingw) |
| Rust | rustup target add x86_64-pc-windows-gnu |
Install on Debian/Ubuntu:
sudo apt install mingw-w64
Uninstall
Installed via pip
pip3 uninstall sysplant
Installed as a standalone clone
rm -rf /path/to/sysplant
Installed via Poetry
# Remove the virtual environment
cd /path/to/sysplant
poetry env remove --all
# Then delete the project directory
rm -rf /path/to/sysplant