Skip to content

Commit f1492a4

Browse files
committed
docs: expand README with install, onboard, and provider guide
1 parent fe980d2 commit f1492a4

File tree

1 file changed

+56
-14
lines changed

1 file changed

+56
-14
lines changed

README.md

Lines changed: 56 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -116,30 +116,66 @@ k8sclaw/
116116
└── README.md
117117
```
118118

119-
## Prerequisites
119+
## Getting Started
120120

121-
- Kubernetes cluster (v1.28+)
122-
- `kubectl` configured to your cluster
123-
124-
> NATS and cert-manager are installed automatically by `k8sclaw install`.
125-
126-
## Quick Start
121+
### 1. Install the CLI
127122

128123
```bash
129-
# Install the CLI
130124
curl -fsSL https://deploy.k8sclaw.ai/install.sh | sh
125+
```
131126

132-
# Deploy to your cluster
127+
This detects your OS and architecture, downloads the latest release binary, and installs it to `/usr/local/bin` (or `~/.local/bin`).
128+
129+
### 2. Deploy K8sClaw to your cluster
130+
131+
```bash
133132
k8sclaw install
133+
```
134+
135+
This applies CRDs, RBAC, the controller manager, API server, admission webhook, NATS event bus,
136+
cert-manager (if not present), and network policies to your current `kubectl` context.
137+
138+
To install a specific version:
139+
140+
```bash
141+
k8sclaw install --version v0.0.8
142+
```
134143

135-
# Or install a specific version
136-
k8sclaw install --version v0.1.0
144+
### 3. Onboard — interactive setup wizard
137145

138-
# Create a sample ClawInstance
139-
kubectl apply -f https://raw.githubusercontent.com/AlexsJones/k8sclaw/main/config/samples/clawinstance_sample.yaml
146+
```bash
147+
k8sclaw onboard
148+
```
149+
150+
The wizard walks you through five steps:
151+
152+
```
153+
╔═══════════════════════════════════════════╗
154+
║ K8sClaw · Onboarding Wizard ║
155+
╚═══════════════════════════════════════════╝
156+
157+
📋 Step 1/5 — Cluster check
158+
📋 Step 2/5 — Name your ClawInstance
159+
📋 Step 3/5 — Choose your AI provider
160+
📋 Step 4/5 — Connect a channel (optional)
161+
📋 Step 5/5 — Apply default policy
140162
```
141163

142-
### CLI Usage
164+
**Step 3** supports any GenAI provider:
165+
166+
| Provider | Base URL | API Key |
167+
|----------|----------|---------|
168+
| OpenAI | (default) | `OPENAI_API_KEY` |
169+
| Anthropic | (default) | `ANTHROPIC_API_KEY` |
170+
| GitHub Copilot | `https://api.githubcopilot.com` | `GITHUB_TOKEN` (PAT with `copilot` scope) |
171+
| Azure OpenAI | your endpoint | `AZURE_OPENAI_API_KEY` |
172+
| Ollama | `http://ollama:11434/v1` | none |
173+
| Any OpenAI-compatible | custom URL | custom |
174+
175+
**Step 4** connects a messaging channel — Telegram (easiest), Slack, Discord, or WhatsApp.
176+
The wizard creates the K8s Secrets, ClawPolicy, and ClawInstance for you.
177+
178+
### 4. Use the CLI
143179

144180
```bash
145181
k8sclaw instances list # list instances
@@ -149,6 +185,12 @@ k8sclaw features enable browser-automation \
149185
k8sclaw features list --policy default-policy # list feature gates
150186
```
151187

188+
### 5. Remove K8sClaw
189+
190+
```bash
191+
k8sclaw uninstall
192+
```
193+
152194
## Development
153195

154196
```bash

0 commit comments

Comments
 (0)