Skip to content

Commit fb33519

Browse files
yethikrishnaclaude
andcommitted
docs: update README with standalone setup instructions
- Update installation to use @levelcode/cli package name - Add standalone quick start (just set API key and go) - Document both OPENROUTER_API_KEY and ANTHROPIC_API_KEY options - Add standalone vs hosted mode note - Update SDK examples for standalone usage - Fix npm badge to point to @levelcode/cli - Update CI/CD example with correct package name - Check off standalone mode in roadmap Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
1 parent 8c0375d commit fb33519

1 file changed

Lines changed: 38 additions & 23 deletions

File tree

README.md

Lines changed: 38 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<p align="center">
1010
<a href="https://github.com/yethikrishna/levelcode/actions"><img src="https://github.com/yethikrishna/levelcode/workflows/CI/badge.svg" alt="CI Status"></a>
1111
<a href="https://github.com/yethikrishna/levelcode/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="License"></a>
12-
<a href="https://www.npmjs.com/package/levelcode"><img src="https://img.shields.io/npm/v/levelcode.svg" alt="npm version"></a>
12+
<a href="https://www.npmjs.com/package/@levelcode/cli"><img src="https://img.shields.io/npm/v/@levelcode/cli.svg" alt="npm version"></a>
1313
<a href="https://github.com/yethikrishna/levelcode/stargazers"><img src="https://img.shields.io/github/stars/Yethikrishna/levelcode" alt="GitHub stars"></a>
1414
<a href="https://github.com/yethikrishna/levelcode/network/members"><img src="https://img.shields.io/github/forks/Yethikrishna/levelcode" alt="GitHub forks"></a>
1515
</p>
@@ -86,7 +86,7 @@ Build LevelCode into your applications with our production-ready SDK:
8686
import { LevelCodeClient } from '@levelcode/sdk';
8787

8888
const client = new LevelCodeClient({
89-
apiKey: 'your-openrouter-key',
89+
apiKey: process.env.OPENROUTER_API_KEY, // or ANTHROPIC_API_KEY
9090
cwd: '/path/to/project',
9191
});
9292

@@ -126,14 +126,14 @@ export default {
126126
### CLI Installation
127127

128128
```bash
129-
# Using npm
130-
npm install -g levelcode
129+
# Using npm (recommended)
130+
npm install -g @levelcode/cli
131131

132-
# Using bun (recommended, faster)
133-
bun install -g levelcode
132+
# Using npx (no install needed)
133+
npx @levelcode/cli
134134

135-
# Using yarn
136-
yarn global add levelcode
135+
# Using bun
136+
bun install -g @levelcode/cli
137137
```
138138

139139
### SDK Installation
@@ -170,17 +170,21 @@ bun dev
170170

171171
## Quick Start
172172

173+
LevelCode works **fully standalone** — no backend server, no account, no login required. Just set your API key and start coding.
174+
173175
### 1. Set Your API Key
174176

177+
Choose one of the following:
178+
175179
```bash
176-
# Set your OpenRouter API key
180+
# Option A: OpenRouter (200+ models including Claude, GPT, Gemini, DeepSeek, etc.)
177181
export OPENROUTER_API_KEY="sk-or-v1-..."
178182

179-
# Or create a .env file
180-
echo "OPENROUTER_API_KEY=sk-or-v1-..." > .env
183+
# Option B: Anthropic (Claude models directly)
184+
export ANTHROPIC_API_KEY="sk-ant-..."
181185
```
182186

183-
Get your API key from [OpenRouter](https://openrouter.ai/keys).
187+
Get your key from [OpenRouter](https://openrouter.ai/keys) or [Anthropic](https://console.anthropic.com/).
184188

185189
### 2. Run LevelCode
186190

@@ -192,6 +196,8 @@ cd your-project
192196
levelcode
193197
```
194198

199+
That's it. No sign-up, no backend, no configuration needed.
200+
195201
### 3. Start Coding with AI
196202

197203
Just tell LevelCode what you want:
@@ -206,14 +212,17 @@ LevelCode will find the right files, make changes across your codebase, and vali
206212
### CLI Options
207213

208214
```bash
209-
# Use a specific model
210-
levelcode --model anthropic/claude-3.5-sonnet
215+
# Use FREE mode (lightweight, lower cost)
216+
levelcode --free
217+
218+
# Use MAX mode (most capable)
219+
levelcode --max
211220

212221
# Run in a specific directory
213222
levelcode --cwd /path/to/project
214223

215-
# Non-interactive mode with a prompt
216-
levelcode "Add input validation to all forms"
224+
# Continue a previous conversation
225+
levelcode --continue
217226

218227
# Show all options
219228
levelcode --help
@@ -228,10 +237,10 @@ levelcode --help
228237
```typescript
229238
import { LevelCodeClient } from '@levelcode/sdk';
230239

240+
// Works standalone — just provide your API key
231241
const client = new LevelCodeClient({
232-
apiKey: process.env.OPENROUTER_API_KEY,
242+
apiKey: process.env.OPENROUTER_API_KEY, // or ANTHROPIC_API_KEY
233243
cwd: process.cwd(),
234-
onError: (error) => console.error('Error:', error.message),
235244
});
236245

237246
// Run a coding task
@@ -245,7 +254,7 @@ const result = await client.run({
245254
},
246255
});
247256

248-
console.log('Changes:', result.changes);
257+
console.log('Output:', result.output);
249258
```
250259

251260
### Custom Agents
@@ -291,7 +300,7 @@ jobs:
291300
uses: oven-sh/setup-bun@v1
292301

293302
- name: Install LevelCode
294-
run: bun install -g levelcode
303+
run: bun install -g @levelcode/cli
295304

296305
- name: Run AI Review
297306
env:
@@ -381,10 +390,15 @@ export default defineConfig({
381390

382391
| Variable | Description | Required |
383392
|----------|-------------|----------|
384-
| `OPENROUTER_API_KEY` | Your OpenRouter API key | Yes |
393+
| `OPENROUTER_API_KEY` | OpenRouter API key (200+ models) | One of these |
394+
| `ANTHROPIC_API_KEY` | Anthropic API key (Claude direct) | is required |
385395
| `LEVELCODE_MODEL` | Default model to use | No |
386396
| `LEVELCODE_DEBUG` | Enable debug logging | No |
387397

398+
> **Standalone Mode**: LevelCode runs fully standalone by default. No backend server, database, or account is needed. Just set one API key above and you're ready to go.
399+
>
400+
> **Hosted Mode**: For team features, billing, and the agent marketplace, visit [levelcode.ai](https://levelcode.ai).
401+
388402
---
389403

390404
## Documentation
@@ -438,13 +452,14 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
438452

439453
## Roadmap
440454

455+
- [x] Standalone Mode (no backend required)
456+
- [x] Direct OpenRouter/Anthropic API support
441457
- [ ] VS Code Extension
442458
- [ ] JetBrains Plugin
443459
- [ ] Web Interface
444460
- [ ] Team Collaboration
445-
- [ ] Self-Hosted Mode
461+
- [ ] Self-Hosted Server Mode
446462
- [ ] Plugin Marketplace
447-
- [ ] Mobile App
448463

449464
---
450465

0 commit comments

Comments
 (0)