Skip to content

Commit feccf43

Browse files
committed
docs: rewrite install + usage sections for easy onboarding
Clear Install/Usage/Upgrade sections with Homebrew, one-liner, and source options. Emphasizes zero dependencies for binary installs.
1 parent 0d27d1a commit feccf43

1 file changed

Lines changed: 50 additions & 24 deletions

File tree

README.md

Lines changed: 50 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -354,51 +354,77 @@ Each channel adapter handles webhook signature verification, rate limiting, and
354354
| **Codebase** | ~28.5K lines | ~200 lines core | ~4K lines | ~430K lines | ~50K lines | ~30K lines |
355355
| **Tests** | 440 | Minimal | Minimal | Basic | Basic | Basic |
356356

357-
## Quick Start
357+
## Install
358358

359-
### Install
359+
**30 seconds. No Erlang. No Elixir. No compilation.**
360+
361+
### Homebrew (macOS / Linux)
360362

361363
```bash
362-
# Option A: Homebrew (macOS/Linux)
363364
brew tap miosa-osa/tap
364365
brew install osagent
366+
osagent
367+
```
368+
369+
### One-liner (macOS / Linux)
365370

366-
# Option B: Install script (no dependencies needed)
371+
```bash
367372
curl -fsSL https://raw.githubusercontent.com/Miosa-osa/OSA/main/install.sh | sh
373+
osagent
374+
```
368375

369-
# Option C: From source (requires Elixir 1.17+)
376+
### From Source
377+
378+
For contributors or if you want to hack on OSA itself:
379+
380+
```bash
370381
git clone https://github.com/Miosa-osa/OSA.git
371382
cd OSA
372-
mix deps.get
373-
mix osa.setup
374-
mix ecto.create && mix ecto.migrate
375-
mix compile
383+
mix setup # deps + database + compile
384+
mix chat # start talking
376385
```
377386

378-
### Run
387+
Requires Elixir 1.17+ and Erlang/OTP 27+.
379388

380-
```bash
381-
osagent # Start chatting (binary install)
382-
osagent setup # Configure provider + API keys
383-
osagent version # Print version
384-
osagent serve # Headless HTTP API mode
389+
---
385390

386-
# Or from source:
387-
mix chat
391+
## Usage
392+
393+
```bash
394+
osagent # interactive chat (default)
395+
osagent setup # configure provider + API keys
396+
osagent version # print version
397+
osagent serve # headless HTTP API mode (port 8089)
388398
```
389399

390-
### Configure
400+
On first run, `osagent` launches a setup wizard — pick your LLM provider, paste an API key (or choose Ollama for fully local), and you're chatting.
401+
402+
### Switch Providers
391403

392404
```bash
393-
# Local AI (default — free, private)
394-
export OSA_DEFAULT_PROVIDER=ollama
405+
# Local AI (default — free, private, no API key)
406+
osagent setup # select Ollama
395407

396-
# Or any of the 18 supported providers:
397-
export OSA_DEFAULT_PROVIDER=anthropic # or openai, groq, deepseek, together, etc.
398-
export ANTHROPIC_API_KEY=sk-...
408+
# Cloud — pick any of 18 providers
409+
osagent setup # select Anthropic, OpenAI, Groq, DeepSeek, etc.
410+
411+
# Or set env vars directly
412+
export OSA_DEFAULT_PROVIDER=anthropic
413+
export ANTHROPIC_API_KEY=sk-ant-...
414+
osagent
399415
```
400416

401-
Or edit `~/.osa/config.json` directly.
417+
Config lives in `~/.osa/config.json` — edit it directly if you prefer.
418+
419+
### Upgrade
420+
421+
```bash
422+
# Homebrew
423+
brew upgrade osagent
424+
425+
# Install script — just re-run it
426+
curl -fsSL https://raw.githubusercontent.com/Miosa-osa/OSA/main/install.sh | sh
427+
```
402428

403429
### Chat Channels
404430

0 commit comments

Comments
 (0)