Quick Start
đĄ Prefer your AI coding tool?
If you use Claude Code, Cursor, or Codex CLI â run
npx sysknife-setupand follow the wizard. See MCP Server for the full guide. You can skip this page entirely.
Step 1 â Install
Prerequisites: Rust stable (rustup update stable) and an LLM provider
(see Step 2).
git clone https://github.com/lacs-project/sysknife
cd sysknife
make build
sudo make install
sudo systemctl enable --now sysknife-daemon
âšī¸ Fedora / Silverblue
Ubuntu 24.04 is validated with 65/65 stories on a live VM. Ubuntu 22.04 and 26.04 have smoke-test coverage. Fedora Atomic uses the rpm-ostree action family and requires a current Silverblue 44 validation run for each release. Plain Fedora remains experimental. See distro support.
Step 2 â Choose an LLM
Pick one. No account needed for Ollama.
Ollama â local, fully offline, recommended for homelabs:
ollama pull qwen3:8b # runs well on 16 GB RAM
# SysKnife auto-detects Ollama when no cloud key is set
Anthropic:
export ANTHROPIC_API_KEY=sk-ant-...
OpenAI / Gemini / others â see Configuration for the full list of supported providers.
Optional config file (~/.config/sysknife/config.toml):
[llm]
provider = "ollama"
model = "qwen3:8b"
Step 3 â Run
# Safe first run â plan only, nothing executes
sysknife --dry-run "show disk usage"
# Full run with the daemon
sysknife "what packages do I have installed as layers?"
â ī¸ Daemon required for execution
--dry-runworks anywhere and is a great way to test the planner without installing the daemon. Full execution requiressysknife-daemonrunning as root (enabled in Step 1).
That's it. The planner proposes a typed plan, you approve, the daemon executes.
Try without installing anything
On any Linux machine with an API key:
export ANTHROPIC_API_KEY=sk-ant-...
cargo run --bin sysknife -- --dry-run "show disk usage"
Plans the intent and prints the result. No daemon, no root, no installation. Useful for evaluating the planner or running in CI.
What to read next
- CLI Reference â all flags, subcommands, and output formats
- MCP Server â use SysKnife from Claude Code, Cursor, Codex CLI
- Configuration â full provider and storage options
- Distro Support â what works on which distributions