# Silk Code

Silk Code is an open-source, model-agnostic autonomous AI coding platform.

It provides:
- AI coding agents
- CLI and local web GUI
- Multiple cloud and local AI model providers
- DeepSeek, Qwen, Kimi, GLM, MiniMax, Cloudflare Workers AI, and OpenRouter support
- Ollama, vLLM, LM Studio, and OpenAI-compatible endpoint support
- GitHub integration
- Code review, testing, and benchmarking
- Permission-gated tools, checkpoints, and sandboxed execution

## Official Links

Website: https://silkcode.web.app/
Documentation: https://silkcode.web.app/docs
GitHub: https://github.com/RupertCloud/SilkCode
Source: https://github.com/RupertCloud/SilkCode
Agent manifest: https://silkcode.web.app/agent

## Installation

Requires Python 3.10 or newer and git. The following zsh setup is safe to rerun:

```bash
if [ -d "$HOME/SilkCode/.git" ]; then
    git -C "$HOME/SilkCode" pull
else
    git clone https://github.com/RupertCloud/SilkCode.git "$HOME/SilkCode"
fi

cd "$HOME/SilkCode"
[ -d .venv ] || python3 -m venv .venv
.venv/bin/python -m pip install -e .
grep -q 'alias silkcode=' ~/.zshrc 2>/dev/null || \
    echo 'alias silkcode="$HOME/SilkCode/.venv/bin/silkcode"' >> ~/.zshrc
source ~/.zshrc
silkcode --help
```

## CLI

```text
silkcode .
silkcode gui .
silkcode models
silkcode config
silkcode sessions
silkcode review
silkcode test
silkcode benchmark
```

## Documentation

Quick Start: https://silkcode.web.app/quick-start
Installation: https://silkcode.web.app/installation
Documentation index: https://silkcode.web.app/docs
CLI: https://silkcode.web.app/docs/cli
GUI: https://silkcode.web.app/docs/gui
Models: https://silkcode.web.app/docs/models
Providers: https://silkcode.web.app/docs/providers
GitHub: https://silkcode.web.app/docs/github
Sandbox: https://silkcode.web.app/docs/sandbox
Configuration: https://silkcode.web.app/docs/configuration
Architecture: https://silkcode.web.app/docs/architecture

Markdown versions are available under https://silkcode.web.app/docs/*.md.

## Source Documentation

README: https://github.com/RupertCloud/SilkCode/blob/main/README.md
Software Requirements Specification: https://github.com/RupertCloud/SilkCode/blob/main/SRS.md